TCL / Zoom API / Get a meeting
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 "occurrence_id" "quis officia in reprehenderit"
CkJsonObject_UpdateString $queryParams "show_previous_occurrences" "true"
# 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/meetings/:meetingId" $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)
# {
# "agenda": "API overview",
# "created_at": "2019-09-09T15:54:24Z",
# "duration": 60,
# "host_id": "ABcdofjdogh11111",
# "id": 1234555466,
# "join_url": "https://zoom.us/j/1234555466",
# "settings": {
# "alternative_hosts": "example@example.com",
# "approval_type": 2,
# "audio": "both",
# "auto_recording": "local",
# "close_registration": false,
# "cn_meeting": false,
# "enforce_login": false,
# "enforce_login_domains": "example.com",
# "global_dial_in_countries": [
# "US"
# ],
# "global_dial_in_numbers": [
# {
# "city": "New York",
# "country": "US",
# "country_name": "US",
# "number": "+1 000011100",
# "type": "toll"
# },
# {
# "city": "San Jose",
# "country": "US",
# "country_name": "US",
# "number": "+1 6699006833",
# "type": "toll"
# },
# {
# "city": "San Jose",
# "country": "US",
# "country_name": "US",
# "number": "+1 221122112211",
# "type": "toll"
# }
# ],
# "host_video": false,
# "in_meeting": false,
# "join_before_host": true,
# "mute_upon_entry": false,
# "participant_video": false,
# "registrants_confirmation_email": true,
# "use_pmi": false,
# "waiting_room": false,
# "watermark": false,
# "registrants_email_notification": true
# },
# "start_time": "2019-08-30T22:00:00Z",
# "start_url": "https://zoom.us/1234555466/cdknfdffgggdfg4MDUxNjY0LCJpYXQiOjE1NjgwNDQ0NjQsImFpZCI6IjRBOWR2QkRqVHphd2J0amxoejNQZ1EiLCJjaWQiOiIifQ.Pz_msGuQwtylTtYQ",
# "status": "waiting",
# "timezone": "America/New_York",
# "topic": "My API Test",
# "type": 2,
# "uuid": "iAABBBcccdddd7A=="
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set agenda [CkJsonObject_stringOf $jResp "agenda"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set duration [CkJsonObject_IntOf $jResp "duration"]
set host_id [CkJsonObject_stringOf $jResp "host_id"]
set id [CkJsonObject_IntOf $jResp "id"]
set join_url [CkJsonObject_stringOf $jResp "join_url"]
set Alternative_hosts [CkJsonObject_stringOf $jResp "settings.alternative_hosts"]
set Approval_type [CkJsonObject_IntOf $jResp "settings.approval_type"]
set Audio [CkJsonObject_stringOf $jResp "settings.audio"]
set Auto_recording [CkJsonObject_stringOf $jResp "settings.auto_recording"]
set Close_registration [CkJsonObject_BoolOf $jResp "settings.close_registration"]
set Cn_meeting [CkJsonObject_BoolOf $jResp "settings.cn_meeting"]
set Enforce_login [CkJsonObject_BoolOf $jResp "settings.enforce_login"]
set Enforce_login_domains [CkJsonObject_stringOf $jResp "settings.enforce_login_domains"]
set Host_video [CkJsonObject_BoolOf $jResp "settings.host_video"]
set In_meeting [CkJsonObject_BoolOf $jResp "settings.in_meeting"]
set Join_before_host [CkJsonObject_BoolOf $jResp "settings.join_before_host"]
set Mute_upon_entry [CkJsonObject_BoolOf $jResp "settings.mute_upon_entry"]
set Participant_video [CkJsonObject_BoolOf $jResp "settings.participant_video"]
set Registrants_confirmation_email [CkJsonObject_BoolOf $jResp "settings.registrants_confirmation_email"]
set Use_pmi [CkJsonObject_BoolOf $jResp "settings.use_pmi"]
set Waiting_room [CkJsonObject_BoolOf $jResp "settings.waiting_room"]
set Watermark [CkJsonObject_BoolOf $jResp "settings.watermark"]
set Registrants_email_notification [CkJsonObject_BoolOf $jResp "settings.registrants_email_notification"]
set start_time [CkJsonObject_stringOf $jResp "start_time"]
set start_url [CkJsonObject_stringOf $jResp "start_url"]
set status [CkJsonObject_stringOf $jResp "status"]
set timezone [CkJsonObject_stringOf $jResp "timezone"]
set topic [CkJsonObject_stringOf $jResp "topic"]
set v_type [CkJsonObject_IntOf $jResp "type"]
set uuid [CkJsonObject_stringOf $jResp "uuid"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "settings.global_dial_in_countries"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "settings.global_dial_in_countries[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "settings.global_dial_in_numbers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set city [CkJsonObject_stringOf $jResp "settings.global_dial_in_numbers[i].city"]
set country [CkJsonObject_stringOf $jResp "settings.global_dial_in_numbers[i].country"]
set country_name [CkJsonObject_stringOf $jResp "settings.global_dial_in_numbers[i].country_name"]
set v_number [CkJsonObject_stringOf $jResp "settings.global_dial_in_numbers[i].number"]
set v_type_str [CkJsonObject_stringOf $jResp "settings.global_dial_in_numbers[i].type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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/meetings/:meetingId
Postman Collection Item JSON
{
"name": "Get a meeting",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit",
"description": "Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings)."
},
{
"key": "show_previous_occurrences",
"value": "true",
"description": "Set the value of this field to `true` if you would like to view meeting details of all previous occurrences of a [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings). "
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
},
"description": "Retrieve the details of a meeting.<br><br>\n**Scopes:** `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nMeeting object returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"agenda\": \"API overview\",\n \"created_at\": \"2019-09-09T15:54:24Z\",\n \"duration\": 60,\n \"host_id\": \"ABcdofjdogh11111\",\n \"id\": 1234555466,\n \"join_url\": \"https://zoom.us/j/1234555466\",\n \"settings\": {\n \"alternative_hosts\": \"example@example.com\",\n \"approval_type\": 2,\n \"audio\": \"both\",\n \"auto_recording\": \"local\",\n \"close_registration\": false,\n \"cn_meeting\": false,\n \"enforce_login\": false,\n \"enforce_login_domains\": \"example.com\",\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 000011100\",\n \"type\": \"toll\"\n },\n {\n \"city\": \"San Jose\",\n \"country\": \"US\",\n \"country_name\": \"US\",\n \"number\": \"+1 6699006833\",\n \"type\": \"toll\"\n },\n {\n \"city\": \"San Jose\",\n \"country\": \"US\",\n \"country_name\": \"US\",\n \"number\": \"+1 221122112211\",\n \"type\": \"toll\"\n }\n ],\n \"host_video\": false,\n \"in_meeting\": false,\n \"join_before_host\": true,\n \"mute_upon_entry\": false,\n \"participant_video\": false,\n \"registrants_confirmation_email\": true,\n \"use_pmi\": false,\n \"waiting_room\": false,\n \"watermark\": false,\n \"registrants_email_notification\": true\n },\n \"start_time\": \"2019-08-30T22:00:00Z\",\n \"start_url\": \"https://zoom.us/1234555466/cdknfdffgggdfg4MDUxNjY0LCJpYXQiOjE1NjgwNDQ0NjQsImFpZCI6IjRBOWR2QkRqVHphd2J0amxoejNQZ1EiLCJjaWQiOiIifQ.Pz_msGuQwtylTtYQ\",\n \"status\": \"waiting\",\n \"timezone\": \"America/New_York\",\n \"topic\": \"My API Test\",\n \"type\": 2,\n \"uuid\": \"iAABBBcccdddd7A==\"\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser not found on this account: {accountId}.<br>**Error Code:** `3000`<br>\nCannot access webinar info.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nMeeting not found.<br>\n**Error Code:** `1001`<br>\nUser not exist: {userId}.<br>**Error Code:** `3001`<br>\nMeeting {meetingId} is not found or has expired.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
},
{
"key": "show_previous_occurrences",
"value": "true"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
