REST Meeting API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

The following API calls go over the creation, management, and deleting of Meetings through Zooms REST API calls.

Create a meeting on Zoom, return the created meeting URL.

Note: Instant meeting will not be returned when you call the "List meetings" REST API. So if you want the meeting info to persist, you have to do it yourself.

Endpoint:

https://api.zoom.us/v1/meeting/create

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&host_id=your_user_host_id&topic=meeting_topic&type=2' https://api.zoom.us/v1/meeting/create

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <uuid>9qU8IsjNTUuFFjqyWohT7A==</uuid>
    <id>123456789</id>
    <start_url>https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k</start_url>
    <join_url>https://zoom.us/j/123456789</join_url>
    <created_at>2012-11-25T12:00:00Z</created_at>
    <host_id>dh23hdu23gd</host_id>
    <topic>Topic for this meeting</topic>
    <type>2</type>
    <start_time>2012-11-25T12:00:00Z</start_time>
    <duration>30</duration>
    <timezone>America/Los_Angeles</timezone>
    <password>123</password>
    <h323_password>123456</h323_password>
    <option_jbh>false</option_jbh>
    <option_start_type>video</option_start_type>
    <option_host_video>false</option_host_video>
    <option_participants_video>false</option_participants_video >
    <option_audio>both</option_audio>
    <option_enforce_login>false</ option_enforce_login>
    <option_enforce_login_domains></option_enforce_login_domains>
    <option_alternative_hosts></option_alternative_hosts>
    <status>0</status>
</result>

Response JSON:

{
    "uuid":"9qU8IsjNTUuFFjqyWohT7A==",
    "id": 123456789,
    "start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
    "join_url": "https://zoom.us/j/123456789",
    "created_at": "2012-11-25T12:00:00Z",
    "host_id": "dh23hdu23gd",
    "topic": "Topic for this meeting",
    "type": 2,
    "option_jbh": false,
    "option_start_type": "video",
    "start_time": "2012-11-25T12:00:00Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "password": "123",
    "h323_password": "123456",
    "option_host_video": false,
    "option_participants_video": false,
    "option_audio": "both",
    "option_enforce_login": false,
    "option_enforce_login_domains ": "",
    "option_alternative_hosts": "",
    "status": 0
}

Note: "status" variable: 0 means meeting not started. 1 means meeting starting. 2 means meeting finished. 

join_url: https://zoom.us/j/123456789 , partner can add "uname=xxxx" to the join meeting url to avoid Zoom client showing username dialog. For example:

https://zoom.us/j/123456789?uname=Aidan%20Crosbie

Please note the username should be URL encoded.

Delete a meeting on Zoom, return the deleted meeting id.

Endpoint:

https://api.zoom.us/v1/meeting/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=meeting_id&host_id=your_user_host_id' https://api.zoom.us/v1/meeting/delete

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>123456789</id>
    <deleted_at>2012-11-25T12:00:00Z</deleted_at>
</result >

Response JSON:

{
"id": 123456789,
"deleted_at": "2012-11-25T12:00:00Z"
}

List all the scheduled meetings on Zoom.

Endpoint:

https://api.zoom.us/v1/meeting/list

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&host_id=your_user_host_id' https://api.zoom.us/v1/meeting/list

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <page_count>5<page_count>
    <total_records>235<total_records>
    <page_number>1<page_number>
    <page_size>50<page_size>
    <meetings>
        <meeting>
            <uuid>9qU8IsjNTUuFFjqyWohT7A==</uuid>
            <id>123456789</id>
            <start_url>https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k</start_url>
            <join_url>https://zoom.us/j/123456789</join_url>
            <created_at>2012-11-25T12:00:00Z</created_at>
            <host_id>dh23hdu23gd</host_id>
            <topic>Topic for this meeting</topic>
            <type>2</type>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <password>123</password>
            <h323_password>123456</h323_password>
            <option_jbh>false</option_jbh>
            <option_start_type>video</option_start_type>
            <option_host_video>false</option_host_video>
            <option_participants_video>false</option_participants_video>
            <option_audio>both</option_audio>
            <option_enforce_login>false</ option_enforce_login>
            <option_enforce_login_domains></option_enforce_login_domains>
            <option_alternative_hosts></option_alternative_hosts>
            <status>0</status>
        </meeting>
        <meeting>
            <uuid>CJSyvNKnSai43Az8KZLlEw==</uuid>
            <id>456789123</id>
            <start_url>https://zoom.us/s/456789123?zpk=612h23khs65q23kd9sqliy</start_url>
            <join_url>https://zoom.us/j/456789123</join_url>
            <created_at>2012-11-25T12:00:00Z</created_at>
            <host_id>dh23hdu23gd</host_id>
            <topic>Topic for this meeting</topic>
            <type>3</type>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <password>123</password>
            <h323_password>123456</h323_password>
            <option_jbh>false</option_jbh>
            <option_start_type>screen_share</option_start_type>
            <option_host_video>false</option_host_video>
            <option_participants_video>false</option_participants_video>
            <option_audio>both</option_audio>
            <option_enforce_login>false</ option_enforce_login>
            <option_enforce_login_domains></option_enforce_login_domains>
            <option_alternative_hosts></option_alternative_hosts>
            <status>0</status>
        </meeting>
        ...
    </meetings>
</result>

Response JSON:

{
    "page_count": 5,
    "total_records": 235,
    "page_number": 1,
    "page_size": 50,
    "meetings": [
    {
        "uuid":"CJSyvNKnSai43Az8KZLlEw==",
        "id": "123456789",
        "start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
        "join_url": "https://zoom.us/j/123456789",
        "created_at": "2012-11-25T12:00:00Z",
        "host_id": "dh23hdu23gd",
        "topic": "Topic for this meeting",
        "type": 2,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        "password": "123",
        "h323_password": "123456",
        "option_jbh": false,
        "option_start_type": "video",
        "option_host_video": false,
        "option_participants_video": false,
        "option_audio": "both",
        "option_enforce_login": false,
        "option_enforce_login_domains ": "",
        "option_alternative_hosts": "",
        "status": 0
    },
    {
        "uuid":"9qU8IsjNTUuFFjqyWohT7A==",
        "id": "456789123",
        "start_url": "https://zoom.us/s/456789123?zpk=612h23khs65q23kd9sqliy",
        "join_url": "https://zoom.us/s/456789123",
        "created_at": "2012-11-25T12:00:00Z",
        "host_id": "dh23hdu23gd",
        "topic": "Topic for this meeting",
        "type": 3,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        "password": "123",
        "h323_password": "123456",
        "option_jbh": false,
        "option_start_type": "screen_share",
        "option_host_video": false,
        "option_participants_video": false,
        "option_audio": "both",
        "option_enforce_login": false,
        "option_enforce_login_domains ": "",
        "option_alternative_hosts": "",
        "status": 0
    }
    ...
    ]
}

Note: Note: "status" variable: 0 means meeting not started. 1 means meeting started. 2 means meeting finished.

join_url: https://zoom.us/j/123456789, partner can add "uname=xxxx" to the join meeting url to avoid Zoom client showing username dialog, https://zoom.us/j/123456789?uname=mike%20mason (username should be URL encoded).

Lists the live meetings on Zoom.

Note: Instant meeting will not be returned when you call the "List meetings" REST API. So if you want the meeting info to persist, you have to do it yourself.

Endpoint:

https://api.zoom.us/v1/meeting/live

Parameters:
None

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/meeting/live

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <page_count>1<page_count>
    <total_records>2<total_records>
    <page_number>1<page_number>
    <page_size>2<page_size>
    <meetings>
        <meeting>
            <uuid>9qU8IsjNTUuFFjqyWohT7A==</uuid>
            <id>123456789</id>
            <start_url>https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k</start_url>
            <join_url>https://zoom.us/j/123456789</join_url>
            <created_at>2012-11-25T12:00:00Z</created_at>
            <host_id>dh23hdu23gd</host_id>
            <topic>Topic for this meeting</topic>
            <type>2</type>
            <status>1</status>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <password>123</password>
            <h323_password>123456</h323_password>
            <option_jbh>false</option_jbh>
            <option_start_type>video</option_start_type>
            <option_host_video>false</option_host_video>
            <option_participants_video>false</option_participants_video>
            <option_audio>both</option_audio>
            <option_enforce_login>false</ option_enforce_login>
            <option_enforce_login_domains></option_enforce_login_domains>
            <option_alternative_hosts></option_alternative_hosts>
            <status>0</status>
        </meeting>
        <meeting>
            <uuid>CJSyvNKnSai43Az8KZLlEw==</uuid>
            <id>456789123</id>
            <start_url>https://zoom.us/s/456789123?zpk=612h23khs65q23kd9sqliy</start_url>
            <join_url>https://zoom.us/j/456789123</join_url>
            <created_at>2012-11-25T12:00:00Z</created_at>
            <host_id>dh23hdu23gd</host_id>
            <topic>Topic for this meeting</topic>
            <type>3</type>
            <status>1</status>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <password>123</password>
            <h323_password>123456</h323_password>
            <option_jbh>false</option_jbh>
            <option_start_type>screen_share</option_start_type>
            <option_host_video>false</option_host_video>
            <option_participants_video>false</option_participants_video>
            <option_audio>both</option_audio>
            <option_enforce_login>false</ option_enforce_login>
            <option_enforce_login_domains></option_enforce_login_domains>
            <option_alternative_hosts></option_alternative_hosts>
            <status>0</status>
        </meeting>
        ...
    </meetings>
</result>

Response JSON:

{
    "page_count": 5,
    "total_records": 235,
    "page_number": 1,
    "page_size": 50,
    "meetings": [
    {
        "uuid":"CJSyvNKnSai43Az8KZLlEw==",
        "id": "123456789",
        "start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
        "join_url": "https://zoom.us/j/123456789",
        "created_at": "2012-11-25T12:00:00Z",
        "host_id": "dh23hdu23gd",
        "topic": "Topic for this meeting",
        "type": 2,
        "status": 0,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        "password": "123",
        "h323_password": "123456",
        "option_jbh": false,
        "option_start_type": "video",
        "option_host_video": false,
        "option_participants_video": false,
        "option_audio": "both",
        "option_enforce_login": false,
        "option_enforce_login_domains ": "",
        "option_alternative_hosts": "",
        "status": 0
    },
    {
        "uuid":"9qU8IsjNTUuFFjqyWohT7A==",
        "id": "456789123",
        "start_url": "https://zoom.us/s/456789123?zpk=612h23khs65q23kd9sqliy",
        "join_url": "https://zoom.us/s/456789123",
        "created_at": "2012-11-25T12:00:00Z",
        "host_id": "dh23hdu23gd",
        "topic": "Topic for this meeting",
        "type": 3,
        "status": 1,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        "password": "123",
        "h323_password": "123456",
        "option_jbh": false,
        "option_start_type": "screen_share",
        "option_host_video": false,
        "option_participants_video": false,
        "option_audio": "both",
        "option_enforce_login": false,
        "option_enforce_login_domains ": "",
        "option_alternative_hosts": "",
        "status": 0
    }
    ...
    ]
}

Get a meeting on Zoom via meeting id, return the meeting info.

Endpoint:

https://api.zoom.us/v1/meeting/get

Parameters:


cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=meeting_id&host_id=your_user_host_id' https://api.zoom.us/v1/meeting/get

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <uuid>9qU8IsjNTUuFFjqyWohT7A==</uuid>
    <id>123456789</id>
    <start_url>https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k</start_url>
    <join_url>https://zoom.us/j/123456789</join_url>
    <created_at>2012-11-25T12:00:00Z</created_at>
    <host_id>dh23hdu23gd</host_id>
    <topic>Topic for this meeting</topic>
    <type>2</type>
    <status>0</status>
    <start_time>2012-11-25T12:00:00Z</start_time>
    <duration>30</duration>
    <timezone>America/Los_Angeles</timezone>
    <password>123</password>
    <option_jbh>false</option_jbh>
    <option_start_type>video</option_start_type>
    <option_host_video>false</option_host_video>
    <option_participants_video>false</option_participants_video>
    <option_audio>both</option_audio>
    <option_enforce_login>false</ option_enforce_login>
    <option_enforce_login_domains></option_enforce_login_domains>
    <option_alternative_hosts></option_alternative_hosts>
    <status>0</status>
</result >

Response JSON:

{
    "uuid":"9qU8IsjNTUuFFjqyWohT7A==",
    "id": "123456789",
    "start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
    "join_url": "https://zoom.us/j/123456789",
    "created_at": "2012-11-25T12:00:00Z",
    "host_id": "dh23hdu23gd",
    "topic": "Topic for this meeting",
    "type": 2,
    "status": 0,
    "start_time": "2012-11-25T12:00:00Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "password": "123",
    "option_jbh": false,
    "option_start_type": "video",
    "option_host_video": false,
    "option_participants_video": false,
    "option_audio": "both",
    "option_enforce_login": false,
    "option_enforce_login_domains ": "",
    "option_alternative_hosts": "",
    "status": 0
}

Update meeting info on Zoom via meeting id.
Endpoint:

https://api.zoom.us/v1/meeting/update

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=meeting_id&host_id=your_user_host_id' https://api.zoom.us/v1/meeting/update

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>123456789</id>
    <updated_at>2012-11-25T12:00:00Z</updated_at>
</result >

Response JSON:

{
    "id": "123456789",
    "updated_at": "2012-11-25T12:00:00Z"
}

End a meeting on Zoom, return the deleted meeting id.
Note: This API call cannot be used to end on-premise Zoom meetings.

Endpoint:

https://api.zoom.us/v1/meeting/end

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=meeting_id&host_id=your_user_host_id' https://api.zoom.us/v1/meeting/end

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <id>123456789</id>
    <ended_at>2012-11-25T12:00:00Z</ended_at>
</result >

Response JSON:

{
"id": 123456789,
"ended_at": "2012-11-25T12:00:00Z"
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk