TCL / Zoom API / List webinars
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "type" "live"
CkJsonObject_UpdateString $queryParams "from" "1989-05-07"
CkJsonObject_UpdateString $queryParams "to" "1989-05-07"
CkJsonObject_UpdateInt $queryParams "page_size" 30
CkJsonObject_UpdateString $queryParams "next_page_token" "quis officia in reprehenderit"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.zoom.us/v2/metrics/webinars" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "from": "string [date]",
# "to": "string [date]",
# "page_count": "integer",
# "page_size": "integer",
# "total_records": "integer",
# "next_page_token": "string",
# "webinars": [
# {
# "uuid": "string [uuid]",
# "id": "integer",
# "topic": "string",
# "host": "string",
# "email": "string",
# "user_type": "string",
# "start_time": "string [date-time]",
# "end_time": "string [date-time]",
# "duration": "string",
# "participants": "integer",
# "has_pstn": "boolean",
# "has_voip": "boolean",
# "has_3rd_party_audio": "boolean",
# "has_video": "boolean",
# "has_screen_share": "boolean",
# "has_recording": "boolean",
# "has_sip": "boolean",
# "has_archiving": "boolean"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set from [CkJsonObject_stringOf $jResp "from"]
set v_to [CkJsonObject_stringOf $jResp "to"]
set page_count [CkJsonObject_stringOf $jResp "page_count"]
set page_size [CkJsonObject_stringOf $jResp "page_size"]
set total_records [CkJsonObject_stringOf $jResp "total_records"]
set next_page_token [CkJsonObject_stringOf $jResp "next_page_token"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "webinars"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set uuid [CkJsonObject_stringOf $jResp "webinars[i].uuid"]
set id [CkJsonObject_stringOf $jResp "webinars[i].id"]
set topic [CkJsonObject_stringOf $jResp "webinars[i].topic"]
set host [CkJsonObject_stringOf $jResp "webinars[i].host"]
set email [CkJsonObject_stringOf $jResp "webinars[i].email"]
set user_type [CkJsonObject_stringOf $jResp "webinars[i].user_type"]
set start_time [CkJsonObject_stringOf $jResp "webinars[i].start_time"]
set end_time [CkJsonObject_stringOf $jResp "webinars[i].end_time"]
set duration [CkJsonObject_stringOf $jResp "webinars[i].duration"]
set participants [CkJsonObject_stringOf $jResp "webinars[i].participants"]
set has_pstn [CkJsonObject_stringOf $jResp "webinars[i].has_pstn"]
set has_voip [CkJsonObject_stringOf $jResp "webinars[i].has_voip"]
set has_3rd_party_audio [CkJsonObject_stringOf $jResp "webinars[i].has_3rd_party_audio"]
set has_video [CkJsonObject_stringOf $jResp "webinars[i].has_video"]
set has_screen_share [CkJsonObject_stringOf $jResp "webinars[i].has_screen_share"]
set has_recording [CkJsonObject_stringOf $jResp "webinars[i].has_recording"]
set has_sip [CkJsonObject_stringOf $jResp "webinars[i].has_sip"]
set has_archiving [CkJsonObject_stringOf $jResp "webinars[i].has_archiving"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "type=live"
-d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/webinars
Postman Collection Item JSON
{
"name": "List webinars",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars"
],
"query": [
{
"key": "type",
"value": "live",
"description": "The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`."
},
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
]
},
"description": "List all the live or past webinars from a specified period of time. <br><br>\n**Scopes:** `dashboard_webinars:read:admin`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br>\n**Prerequisites:**<br>\n* Business, Education or API Plan with Webinar add-on.\n\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nMeetings returned.<br>\nOnly available for paid accounts that have enabled the Dashboard feature.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"string [date]\",\n \"to\": \"string [date]\",\n \"page_count\": \"integer\",\n \"page_size\": \"integer\",\n \"total_records\": \"integer\",\n \"next_page_token\": \"string\",\n \"webinars\": [\n {\n \"uuid\": \"string [uuid]\",\n \"id\": \"integer\",\n \"topic\": \"string\",\n \"host\": \"string\",\n \"email\": \"string\",\n \"user_type\": \"string\",\n \"start_time\": \"string [date-time]\",\n \"end_time\": \"string [date-time]\",\n \"duration\": \"string\",\n \"participants\": \"integer\",\n \"has_pstn\": \"boolean\",\n \"has_voip\": \"boolean\",\n \"has_3rd_party_audio\": \"boolean\",\n \"has_video\": \"boolean\",\n \"has_screen_share\": \"boolean\",\n \"has_recording\": \"boolean\",\n \"has_sip\": \"boolean\",\n \"has_archiving\": \"boolean\"\n }\n ]\n}"
},
{
"name": "**Error Code:** `200`<br>\nThe next page token is invalid or has expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"webinars"
],
"query": [
{
"key": "type",
"value": "live"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
