lianja / Zoom API / Get a webinar
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("occurrence_id","quis officia in reprehenderit")
loQueryParams.UpdateString("show_previous_occurrences","true")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/webinars/:webinarId",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "created_at": "2019-09-13T15:35:00Z",
// "duration": 60,
// "host_id": "Labcjskdfsjgfg",
// "id": 12345678,
// "join_url": "https://zoom.us/j/12345678",
// "settings": {
// "allow_multiple_devices": true,
// "alternative_hosts": "",
// "approval_type": 2,
// "audio": "both",
// "auto_recording": "local",
// "close_registration": true,
// "contact_email": "example@example.com",
// "contact_name": "Amal",
// "enforce_login": false,
// "enforce_login_domains": "",
// "global_dial_in_countries": [
// "US"
// ],
// "global_dial_in_numbers": [
// {
// "city": "New York",
// "country": "US",
// "country_name": "US",
// "number": "+1 00000",
// "type": "toll"
// },
// {
// "city": "San Jose",
// "country": "US",
// "country_name": "US",
// "number": "+1 111111111",
// "type": "toll"
// },
// {
// "city": "San Jose",
// "country": "US",
// "country_name": "US",
// "number": "+1 11111110",
// "type": "toll"
// }
// ],
// "hd_video": false,
// "hd_video_for_attendees": false,
// "send_1080p_video_to_attendees": false,
// "host_video": false,
// "on_demand": false,
// "panelists_video": false,
// "practice_session": false,
// "question_answer": true,
// "registrants_confirmation_email": true,
// "registrants_restrict_number": 0,
// "show_share_button": true,
// "registrants_email_notification": true,
// "email_language": "en-US",
// "panelists_invitation_email_notification": true,
// "attendees_and_panelists_reminder_email_notification": {
// "enable": true,
// "type": 1
// },
// "follow_up_attendees_email_notification": {
// "enable": true,
// "type": 1
// },
// "follow_up_absentees_email_notification": {
// "enable": true,
// "type": 1
// }
// },
// "start_time": "2019-08-30T22:00:00Z",
// "start_url": "https://zoom.us/s/00000011110?zhghTlUT1Rjd2FXRgh0amxoejNQZ1EiLCJjaWQiOiIifQ.NJ0CXWQ-yhI8Xv01JvxityBtzp3Bt7odMOEG2L8DLmY",
// "timezone": "America/New_York",
// "topic": "Test Webinar",
// "type": 5,
// "uuid": "nWMHAAAAAAAAAAAAAUDP1A=="
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCreated_at = loJResp.StringOf("created_at")
lnDuration = loJResp.IntOf("duration")
lcHost_id = loJResp.StringOf("host_id")
lnId = loJResp.IntOf("id")
lcJoin_url = loJResp.StringOf("join_url")
llAllow_multiple_devices = loJResp.BoolOf("settings.allow_multiple_devices")
lcAlternative_hosts = loJResp.StringOf("settings.alternative_hosts")
lnApproval_type = loJResp.IntOf("settings.approval_type")
lcAudio = loJResp.StringOf("settings.audio")
lcAuto_recording = loJResp.StringOf("settings.auto_recording")
llClose_registration = loJResp.BoolOf("settings.close_registration")
lcContact_email = loJResp.StringOf("settings.contact_email")
lcContact_name = loJResp.StringOf("settings.contact_name")
llEnforce_login = loJResp.BoolOf("settings.enforce_login")
lcEnforce_login_domains = loJResp.StringOf("settings.enforce_login_domains")
llHd_video = loJResp.BoolOf("settings.hd_video")
llHd_video_for_attendees = loJResp.BoolOf("settings.hd_video_for_attendees")
llSend_1080p_video_to_attendees = loJResp.BoolOf("settings.send_1080p_video_to_attendees")
llHost_video = loJResp.BoolOf("settings.host_video")
llOn_demand = loJResp.BoolOf("settings.on_demand")
llPanelists_video = loJResp.BoolOf("settings.panelists_video")
llPractice_session = loJResp.BoolOf("settings.practice_session")
llQuestion_answer = loJResp.BoolOf("settings.question_answer")
llRegistrants_confirmation_email = loJResp.BoolOf("settings.registrants_confirmation_email")
lnRegistrants_restrict_number = loJResp.IntOf("settings.registrants_restrict_number")
llShow_share_button = loJResp.BoolOf("settings.show_share_button")
llRegistrants_email_notification = loJResp.BoolOf("settings.registrants_email_notification")
lcEmail_language = loJResp.StringOf("settings.email_language")
llPanelists_invitation_email_notification = loJResp.BoolOf("settings.panelists_invitation_email_notification")
llEnable = loJResp.BoolOf("settings.attendees_and_panelists_reminder_email_notification.enable")
lnV_Type = loJResp.IntOf("settings.attendees_and_panelists_reminder_email_notification.type")
llFollow_up_attendees_email_notificationEnable = loJResp.BoolOf("settings.follow_up_attendees_email_notification.enable")
lnFollow_up_attendees_email_notificationType = loJResp.IntOf("settings.follow_up_attendees_email_notification.type")
llFollow_up_absentees_email_notificationEnable = loJResp.BoolOf("settings.follow_up_absentees_email_notification.enable")
lnFollow_up_absentees_email_notificationType = loJResp.IntOf("settings.follow_up_absentees_email_notification.type")
lcStart_time = loJResp.StringOf("start_time")
lcStart_url = loJResp.StringOf("start_url")
lcTimezone = loJResp.StringOf("timezone")
lcTopic = loJResp.StringOf("topic")
lnV_type = loJResp.IntOf("type")
lcUuid = loJResp.StringOf("uuid")
i = 0
lnCount_i = loJResp.SizeOfArray("settings.global_dial_in_countries")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("settings.global_dial_in_countries[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("settings.global_dial_in_numbers")
do while i < lnCount_i
loJResp.I = i
lcCity = loJResp.StringOf("settings.global_dial_in_numbers[i].city")
lcCountry = loJResp.StringOf("settings.global_dial_in_numbers[i].country")
lcCountry_name = loJResp.StringOf("settings.global_dial_in_numbers[i].country_name")
lcV_number = loJResp.StringOf("settings.global_dial_in_numbers[i].number")
lcV_type_str = loJResp.StringOf("settings.global_dial_in_numbers[i].type")
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
Curl Command
curl -G -d "occurrence_id=quis%20officia%20in%20reprehenderit"
-d "show_previous_occurrences=true"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId
Postman Collection Item JSON
{
"name": "Get a webinar",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit",
"description": "Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [Create a Webinar API](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate), you can retrieve the Occurrence ID from the response of the API call."
},
{
"key": "show_previous_occurrences",
"value": "true",
"description": "Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar."
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID)."
}
]
},
"description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.<br>Use this API to get details of a scheduled webinar.<br><br>\n**Scopes:** `webinar:read:admin` `webinar:read`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>**Prerequisites:**\n* Pro or higher plan with a Webinar Add-on."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nSuccess",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"created_at\": \"2019-09-13T15:35:00Z\",\n \"duration\": 60,\n \"host_id\": \"Labcjskdfsjgfg\",\n \"id\": 12345678,\n \"join_url\": \"https://zoom.us/j/12345678\",\n \"settings\": {\n \"allow_multiple_devices\": true,\n \"alternative_hosts\": \"\",\n \"approval_type\": 2,\n \"audio\": \"both\",\n \"auto_recording\": \"local\",\n \"close_registration\": true,\n \"contact_email\": \"example@example.com\",\n \"contact_name\": \"Amal\",\n \"enforce_login\": false,\n \"enforce_login_domains\": \"\",\n \"global_dial_in_countries\": [\n \"US\"\n ],\n \"global_dial_in_numbers\": [\n {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"country_name\": \"US\",\n \"number\": \"+1 00000\",\n \"type\": \"toll\"\n },\n {\n \"city\": \"San Jose\",\n \"country\": \"US\",\n \"country_name\": \"US\",\n \"number\": \"+1 111111111\",\n \"type\": \"toll\"\n },\n {\n \"city\": \"San Jose\",\n \"country\": \"US\",\n \"country_name\": \"US\",\n \"number\": \"+1 11111110\",\n \"type\": \"toll\"\n }\n ],\n \"hd_video\": false,\n \"hd_video_for_attendees\": false,\n \"send_1080p_video_to_attendees\": false,\n \"host_video\": false,\n \"on_demand\": false,\n \"panelists_video\": false,\n \"practice_session\": false,\n \"question_answer\": true,\n \"registrants_confirmation_email\": true,\n \"registrants_restrict_number\": 0,\n \"show_share_button\": true,\n \"registrants_email_notification\": true,\n \"email_language\": \"en-US\",\n \"panelists_invitation_email_notification\": true,\n \"attendees_and_panelists_reminder_email_notification\": {\n \"enable\": true,\n \"type\": 1\n },\n \"follow_up_attendees_email_notification\": {\n \"enable\": true,\n \"type\": 1\n },\n \"follow_up_absentees_email_notification\": {\n \"enable\": true,\n \"type\": 1\n }\n },\n \"start_time\": \"2019-08-30T22:00:00Z\",\n \"start_url\": \"https://zoom.us/s/00000011110?zhghTlUT1Rjd2FXRgh0amxoejNQZ1EiLCJjaWQiOiIifQ.NJ0CXWQ-yhI8Xv01JvxityBtzp3Bt7odMOEG2L8DLmY\",\n \"timezone\": \"America/New_York\",\n \"topic\": \"Test Webinar\",\n \"type\": 5,\n \"uuid\": \"nWMHAAAAAAAAAAAAAUDP1A==\"\n}"
},
{
"name": "**HTTP Status Code:** `300`<br>Invalid webinar ID.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID)."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID)."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nWebinar not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3001`<br>\nWebinar {webinarId} not found or has expired.<br>",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "webinarId",
"value": "quis officia in reprehenderit",
"description": "(Required) The webinar's ID or universally unique ID (UUID)."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
