DataFlex / Zoom API / Get a meeting
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sCity
String sCountry
String sCountry_name
String sV_number
String sV_type_str
String sAgenda
String sCreated_at
Integer iDuration
String sHost_id
Integer iId
String sJoin_url
String sAlternative_hosts
Integer iApproval_type
String sAudio
String sAuto_recording
Boolean iClose_registration
Boolean iCn_meeting
Boolean iEnforce_login
String sEnforce_login_domains
Boolean iHost_video
Boolean iIn_meeting
Boolean iJoin_before_host
Boolean iMute_upon_entry
Boolean iParticipant_video
Boolean iRegistrants_confirmation_email
Boolean iUse_pmi
Boolean iWaiting_room
Boolean iWatermark
Boolean iRegistrants_email_notification
String sStart_time
String sStart_url
String sStatus
String sTimezone
String sTopic
Integer iV_type
String sUuid
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "occurrence_id" "quis officia in reprehenderit" To iSuccess
Get ComUpdateString Of hoQueryParams "show_previous_occurrences" "true" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/meetings/:meetingId" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "agenda" To sAgenda
Get ComStringOf Of hoJResp "created_at" To sCreated_at
Get ComIntOf Of hoJResp "duration" To iDuration
Get ComStringOf Of hoJResp "host_id" To sHost_id
Get ComIntOf Of hoJResp "id" To iId
Get ComStringOf Of hoJResp "join_url" To sJoin_url
Get ComStringOf Of hoJResp "settings.alternative_hosts" To sAlternative_hosts
Get ComIntOf Of hoJResp "settings.approval_type" To iApproval_type
Get ComStringOf Of hoJResp "settings.audio" To sAudio
Get ComStringOf Of hoJResp "settings.auto_recording" To sAuto_recording
Get ComBoolOf Of hoJResp "settings.close_registration" To iClose_registration
Get ComBoolOf Of hoJResp "settings.cn_meeting" To iCn_meeting
Get ComBoolOf Of hoJResp "settings.enforce_login" To iEnforce_login
Get ComStringOf Of hoJResp "settings.enforce_login_domains" To sEnforce_login_domains
Get ComBoolOf Of hoJResp "settings.host_video" To iHost_video
Get ComBoolOf Of hoJResp "settings.in_meeting" To iIn_meeting
Get ComBoolOf Of hoJResp "settings.join_before_host" To iJoin_before_host
Get ComBoolOf Of hoJResp "settings.mute_upon_entry" To iMute_upon_entry
Get ComBoolOf Of hoJResp "settings.participant_video" To iParticipant_video
Get ComBoolOf Of hoJResp "settings.registrants_confirmation_email" To iRegistrants_confirmation_email
Get ComBoolOf Of hoJResp "settings.use_pmi" To iUse_pmi
Get ComBoolOf Of hoJResp "settings.waiting_room" To iWaiting_room
Get ComBoolOf Of hoJResp "settings.watermark" To iWatermark
Get ComBoolOf Of hoJResp "settings.registrants_email_notification" To iRegistrants_email_notification
Get ComStringOf Of hoJResp "start_time" To sStart_time
Get ComStringOf Of hoJResp "start_url" To sStart_url
Get ComStringOf Of hoJResp "status" To sStatus
Get ComStringOf Of hoJResp "timezone" To sTimezone
Get ComStringOf Of hoJResp "topic" To sTopic
Get ComIntOf Of hoJResp "type" To iV_type
Get ComStringOf Of hoJResp "uuid" To sUuid
Move 0 To i
Get ComSizeOfArray Of hoJResp "settings.global_dial_in_countries" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "settings.global_dial_in_countries[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "settings.global_dial_in_numbers" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "settings.global_dial_in_numbers[i].city" To sCity
Get ComStringOf Of hoJResp "settings.global_dial_in_numbers[i].country" To sCountry
Get ComStringOf Of hoJResp "settings.global_dial_in_numbers[i].country_name" To sCountry_name
Get ComStringOf Of hoJResp "settings.global_dial_in_numbers[i].number" To sV_number
Get ComStringOf Of hoJResp "settings.global_dial_in_numbers[i].type" To sV_type_str
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
