PureBasic / Zoom API / Get a meeting
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"occurrence_id","quis officia in reprehenderit")
CkJsonObject::ckUpdateString(queryParams,"show_previous_occurrences","true")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/meetings/:meetingId",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
strVal.s
city.s
country.s
country_name.s
v_number.s
v_type_str.s
agenda.s = CkJsonObject::ckStringOf(jResp,"agenda")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
duration.i = CkJsonObject::ckIntOf(jResp,"duration")
host_id.s = CkJsonObject::ckStringOf(jResp,"host_id")
id.i = CkJsonObject::ckIntOf(jResp,"id")
join_url.s = CkJsonObject::ckStringOf(jResp,"join_url")
Alternative_hosts.s = CkJsonObject::ckStringOf(jResp,"settings.alternative_hosts")
Approval_type.i = CkJsonObject::ckIntOf(jResp,"settings.approval_type")
Audio.s = CkJsonObject::ckStringOf(jResp,"settings.audio")
Auto_recording.s = CkJsonObject::ckStringOf(jResp,"settings.auto_recording")
Close_registration.i = CkJsonObject::ckBoolOf(jResp,"settings.close_registration")
Cn_meeting.i = CkJsonObject::ckBoolOf(jResp,"settings.cn_meeting")
Enforce_login.i = CkJsonObject::ckBoolOf(jResp,"settings.enforce_login")
Enforce_login_domains.s = CkJsonObject::ckStringOf(jResp,"settings.enforce_login_domains")
Host_video.i = CkJsonObject::ckBoolOf(jResp,"settings.host_video")
In_meeting.i = CkJsonObject::ckBoolOf(jResp,"settings.in_meeting")
Join_before_host.i = CkJsonObject::ckBoolOf(jResp,"settings.join_before_host")
Mute_upon_entry.i = CkJsonObject::ckBoolOf(jResp,"settings.mute_upon_entry")
Participant_video.i = CkJsonObject::ckBoolOf(jResp,"settings.participant_video")
Registrants_confirmation_email.i = CkJsonObject::ckBoolOf(jResp,"settings.registrants_confirmation_email")
Use_pmi.i = CkJsonObject::ckBoolOf(jResp,"settings.use_pmi")
Waiting_room.i = CkJsonObject::ckBoolOf(jResp,"settings.waiting_room")
Watermark.i = CkJsonObject::ckBoolOf(jResp,"settings.watermark")
Registrants_email_notification.i = CkJsonObject::ckBoolOf(jResp,"settings.registrants_email_notification")
start_time.s = CkJsonObject::ckStringOf(jResp,"start_time")
start_url.s = CkJsonObject::ckStringOf(jResp,"start_url")
status.s = CkJsonObject::ckStringOf(jResp,"status")
timezone.s = CkJsonObject::ckStringOf(jResp,"timezone")
topic.s = CkJsonObject::ckStringOf(jResp,"topic")
v_type.i = CkJsonObject::ckIntOf(jResp,"type")
uuid.s = CkJsonObject::ckStringOf(jResp,"uuid")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"settings.global_dial_in_countries")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_countries[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"settings.global_dial_in_numbers")
While i < count_i
CkJsonObject::setCkI(jResp, i)
city = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_numbers[i].city")
country = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_numbers[i].country")
country_name = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_numbers[i].country_name")
v_number = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_numbers[i].number")
v_type_str = CkJsonObject::ckStringOf(jResp,"settings.global_dial_in_numbers[i].type")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
