lianja / Zoom API / Get a meeting
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/meetings/:meetingId",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)
// {
// "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
lcAgenda = loJResp.StringOf("agenda")
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")
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")
llCn_meeting = loJResp.BoolOf("settings.cn_meeting")
llEnforce_login = loJResp.BoolOf("settings.enforce_login")
lcEnforce_login_domains = loJResp.StringOf("settings.enforce_login_domains")
llHost_video = loJResp.BoolOf("settings.host_video")
llIn_meeting = loJResp.BoolOf("settings.in_meeting")
llJoin_before_host = loJResp.BoolOf("settings.join_before_host")
llMute_upon_entry = loJResp.BoolOf("settings.mute_upon_entry")
llParticipant_video = loJResp.BoolOf("settings.participant_video")
llRegistrants_confirmation_email = loJResp.BoolOf("settings.registrants_confirmation_email")
llUse_pmi = loJResp.BoolOf("settings.use_pmi")
llWaiting_room = loJResp.BoolOf("settings.waiting_room")
llWatermark = loJResp.BoolOf("settings.watermark")
llRegistrants_email_notification = loJResp.BoolOf("settings.registrants_email_notification")
lcStart_time = loJResp.StringOf("start_time")
lcStart_url = loJResp.StringOf("start_url")
lcStatus = loJResp.StringOf("status")
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/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": ""
}
]
}
