REST Webinar 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 Webinars through Zooms REST API calls. These API calls require the Webinar Add-On to be assigned to a user.

Create a webinar on Zoom, return the created webinar start and join URL.
Note: Registrants just enter their email address and display name at the time of the webinar to join. No confirmation/reminder email.

Endpoint:

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

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&host_id=your_user_id&topic=webinar_topic' https://api.zoom.us/v1/webinar/create

Response XML: 

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <uuid>vkYJWaQES4GL8zhxFu/Bsw==</uuid>
    <id>613426621</id>
    <host_id>AjXQQ36-RxGis5_7In8wZQ</host_id>
    <topic>2 create webinar via rest api</topic>
    <agenda>2 create webinar via rest api</agenda>
    <status>0</status>
    <option_start_type>video</option_start_type>
    <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>
    <type>5</type>
    <start_time> 2015-02-08T12:50:30Z</start_time>
    <duration>0</duration>
    <timezone>America/Los_Angeles</timezone>
    <start_url>https://zoom.us/s/613426621?zpk=zru7w3_iPZ </start_url>
    <join_url>https://zoom.us/j/613426621</join_url>
    <registration_url></registration_url>
    <created_at>2015-01-22T07:11:31Z</created_at>
</result>

Response JSON:

{
    "uuid": "4WfJ+bEbRi6wCONO0DmUKw==",
    "id": 762762604,
    "host_id": "AjXQQ36-RxGis5_7In8wZQ",
    "topic": "create webinar via rest api",
    "agenda": "",
    "status": 0,
    "option_start_type": "video",
    "option_audio": "both",
    "option_enforce_login": false,
    "option_enforce_login_domains ": "",
    "option_alternative_hosts": "",
    "type": 5,
    "start_time": " 2015-02-08T12:50:30Z",
    "duration": 0,
    "timezone": "America/Los_Angeles",
    "start_url": "https://zoom.us/s/762762604?zpk=0Oti_Z0tCy ",
    "join_url": "https://zoom.us/j/762762604",
    "registration_url": "",
    "created_at": "2015-01-22T07:09:49Z"
}

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

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

Endpoint

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

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&host_id=your_user_host_id' https://api.zoom.us/v1/webinar/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 registrationless Webinars on Zoom

Endpoint:

https://api.zoom.us/v1/webinar/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/webinar/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>
    <webinars>
        <webinar>
            <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 webinar</topic>
            <agenda>Topic for this webinar</agenda>
            <type>5</type>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <option_start_type>video</option_start_type>
            <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>
        </webinar>
        <webinar>
            <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 webinar</topic>
            <agenda>Topic for this webinar</agenda>
            <type>5</type>
            <start_time>2012-11-25T12:00:00Z</start_time>
            <duration>30</duration>
            <timezone>America/Los_Angeles</timezone>
            <option_start_type>screen_share</option_start_type>
            <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>
        </webinar>
    ...
</webinars>
</result>

Response JSON: 

{
    "page_count": 5,
    "total_records": 235,
    "page_number": 1,
    "page_size": 50,
    "webinars": [
    {
        "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": 5,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        "agenda": "",
        "option_start_type": "video",
        "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": 5,
        "start_time": "2012-11-25T12:00:00Z",
        "duration": 30,
        "timezone": "America/Los_Angeles",
        " agenda ": "",
        "option_start_type": "screen_share",
        "option_audio": "both",
        "option_enforce_login": false,
        "option_enforce_login_domains ": "",
        "option_alternative_hosts": "",
        "status": 0
    }
    ...
    ]
}

List all the upcoming registration-based Webinars on Zoom

Endpoint:

https://api.zoom.us/v1/webinar/list/registration

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/list/registration

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>
<webinars>
    <webinar> 
    <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 webinar</topic>
    <agenda>Topic for this webinar</agenda>
    <type>5</type>
    <start_time>2012-11-25T12:00:00Z</start_time>
    <duration>30</duration>
    <timezone>America/Los_Angeles</timezone>
    <option_start_type>video</option_start_type>
    <option_audio>both</option_audio>
    <status>0</status> 
    </webinar>
    <webinar>
    <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 webinar</topic>
    <agenda>Topic for this webinar</agenda>
    <type>5</type>
    <start_time>2012-11-25T12:00:00Z</start_time>
    <duration>30</duration>
    <timezone>America/Los_Angeles</timezone>
    <option_start_type>screen_share</option_start_type>
    <option_audio>both</option_audio>
    <status>0</status> 
    </webinar>
...
</webinars>
</result>

Response JSON: 

{
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"webinars": [
{ 
    "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 Webinar",
    "type": 5,
    "start_time": "2012-11-25T12:00:00Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "agenda": "",
    "option_start_type": "video",
    "option_audio": "both",
    "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 Webinar",
    "type": 5,
    "start_time": "2012-11-25T12:00:00Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    " agenda ": "",
    "option_start_type": "screen_share",
    "option_audio": "both",
    "status": 0 
}
...
]
}

Get a Webinar on Zoom via Webinar id, return the Webinar info

Endpoint:

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

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&host_id=your_user_host_id' https://api.zoom.us/v1/webinar/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>
    <registration_url></registration_url>
    <created_at>2012-11-25T12:00:00Z</created_at>
    <host_id>dh23hdu23gd</host_id>
    <topic>Topic for this meeting</topic>
    <agenda>Topic for this meeting</agenda>
    <type>5</type>
    <start_time>2012-11-25T12:00:00Z</start_time>
    <duration>30</duration>
    <timezone>America/Los_Angeles</timezone>
    <option_start_type>video</option_start_type>
    <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",
    "registration_url": "",
    "created_at": "2012-11-25T12:00:00Z",
    "host_id": "dh23hdu23gd",
    "topic": "Topic for this meeting",
    "type": 5,
    "start_time": "2012-11-25T12:00:00Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "agenda": "",
    "option_start_type": "video",
    "option_audio": "both",
    "option_enforce_login": false,
    "option_enforce_login_domains ": "",
    "option_alternative_hosts": "",
    "status": 0
}

Update Webinar info on Zoom via Webinar id

Endpoint

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

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&host_id=your_user_host_id' https://api.zoom.us/v1/webinar/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 Webinar on Zoom, return the deleted Webinar id

Endpoint

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

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&host_id=your_user_host_id' https://api.zoom.us/v1/webinar/edn

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"
}

Gather Webinar registrants info

Endpoint

https://api.zoom.us/v1/webinar/registration

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&host_id=your_user_host_id' https://api.zoom.us/v1/webinar/registration

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>
<attendees>
  <attendee>
  <first_name>dff</first_name>
  <last_name>tttt</last_name>
  <create_time>2015-08-23T03:03:48Z</create_time>
  <approval>approved</approval>
  <email>test@test.test</email>
  <registration_url>https://api.zoom.us/w/11111111?tk=n8-qbK4ocC73mPjIRlheMksYPxeWAhnktoUZq_xAqg8.DQEAAAAADE088hZKTXcxTllpelFjZXNfNDg0NlNKQ3lRAA</registration_url>
  </attendee>
</attendees>
</result> 

Response JSON: 

{
"page_count":1,
"page_number":1,
"page_size":30,
"total_records":1,
"attendees":
[
  {
    "first_name":"dff",
    "last_name":"tttt",
    "create_time":"2015-08-23T03:03:48Z",
    "approval":"approved",
    "email":"test@test.test",         
    "registration_url":"https://api.zoom.us/w/206388466?tk=n8-qbK4ocC73mPjIRlheMksYPxeWAhnktoUZq_xAqg8.DQEAAAAADE088hZKTXcxTllpelFjZXNfNDg0NlNKQ3lRAA"
 }
]
}

Get ended webinar UUID.

Endpoint:

https://api.zoom.us/v1/webinar/uuid/list

Parameters:

cURL Example:

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

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
<webinars>
    <webinar>
    <uuid>9qU8IsjNTUuFFjqyWohT7A==</uuid>
    <start_time>2015-08-23T03:03:48Z</ start_time>
    </webinar>
</webinars> 
</result> 

Response JSON:

{
"webinars":
[
{
    " uuid":"9qU8IsjNTUuFFjqyWohT7A==",
    "start_time":"2015-08-23T03:03:48Z"
},
{
    " uuid":"dfd58sjNTUuFFjqyWohT7A==",
    "start_time":"2015-08-25T11:08:22Z"
}
]
}

Get ended webinar attendees

Endpoint:

https://api.zoom.us/v1/webinar/attendees/list

Parameters:

cURL Example:

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

 

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<result>
<attendees>
    <attendee>
    <first_name>first</first_name>
    <last_name>last</last_name>
    <email>full@mailinator.com</email>
    <join_time></join_time>
    <leave_time></leave_time>
    <time_in_session></time_in_session>
    <attended>No</attended>
    <custom_questions>
    <entry>
    <string>ssssss</string>
    <string>ssss</string>
    </entry>
    </custom_questions>
    <questions>
    <entry>
     <string>country</string>
     <string>AL</string>
    </entry>
    </questions>
    </attendee>
……
</attendees> 
</result> 

Response JSON:

{
"attendees":
[
{
    "first_name":"test",
    "last_name":"last",
    "email":"test@test.test",
    "join_time":"2015-09-18T09:41:39Z",
    "leave_time":"2015-09-18T09:42:12Z",
    "time_in_session":"8",
    "attended":"Yes",
    "custom_questions":
    {
     "ssssss":" sssss",
     "which one do you like?":"sss"
    },
    "questions":
    {
     "country":"AL",
     "address":"address",
      "city":"city"
    }
}
……
]
}

Register for a webinar

Endpoint:

https://api.zoom.us/v1/webinar/register

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=webinar_id&email=user@email.com&first_name=Bob&last_name=Smith' https://api.zoom.us/v1/webinar/register

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>869275230</id>
    <topic>webinar registration </topic>
    <start_time>2016-02-21T04:00:00Z</start_time>
    <join_url>https://www.zoom.us/w/869275230?tk=2DsQiu6nZVsZVATrPLvXgqPvw8mmKyxgAGaDMizLv34.DQEAAAAAM9AWXhZ2Nm5vRjIyMlRoUzE3ZktWM3l4cHVRAA</join_url>
</result>

Response JSON:

{
    "id": 869275230,
    "topic": " webinar registration ",
    "start_time": "2016-02-21T04:00:00Z",
    "join_url":"https://www.zoom.us/w/869275230?tk=2DsQiu6nZVsZVATrPLvXgqPvw8mmKyxgAGaDMizLv34.DQEAAAAAM9AWXhZ2Nm5vRjIyMlRoUzE3ZktWM3l4cHVRAA"
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk