delphiAx / Zoom API / Get a meeting
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
strVal: WideString;
city: WideString;
country: WideString;
country_name: WideString;
v_number: WideString;
v_type_str: WideString;
agenda: WideString;
created_at: WideString;
duration: Integer;
host_id: WideString;
id: Integer;
join_url: WideString;
Alternative_hosts: WideString;
Approval_type: Integer;
Audio: WideString;
Auto_recording: WideString;
Close_registration: Integer;
Cn_meeting: Integer;
Enforce_login: Integer;
Enforce_login_domains: WideString;
Host_video: Integer;
In_meeting: Integer;
Join_before_host: Integer;
Mute_upon_entry: Integer;
Participant_video: Integer;
Registrants_confirmation_email: Integer;
Use_pmi: Integer;
Waiting_room: Integer;
Watermark: Integer;
Registrants_email_notification: Integer;
start_time: WideString;
start_url: WideString;
status: WideString;
timezone: WideString;
topic: WideString;
v_type: Integer;
uuid: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('occurrence_id','quis officia in reprehenderit');
queryParams.UpdateString('show_previous_occurrences','true');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.QuickRequestParams('GET','https://api.zoom.us/v2/meetings/:meetingId',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
agenda := jResp.StringOf('agenda');
created_at := jResp.StringOf('created_at');
duration := jResp.IntOf('duration');
host_id := jResp.StringOf('host_id');
id := jResp.IntOf('id');
join_url := jResp.StringOf('join_url');
Alternative_hosts := jResp.StringOf('settings.alternative_hosts');
Approval_type := jResp.IntOf('settings.approval_type');
Audio := jResp.StringOf('settings.audio');
Auto_recording := jResp.StringOf('settings.auto_recording');
Close_registration := jResp.BoolOf('settings.close_registration');
Cn_meeting := jResp.BoolOf('settings.cn_meeting');
Enforce_login := jResp.BoolOf('settings.enforce_login');
Enforce_login_domains := jResp.StringOf('settings.enforce_login_domains');
Host_video := jResp.BoolOf('settings.host_video');
In_meeting := jResp.BoolOf('settings.in_meeting');
Join_before_host := jResp.BoolOf('settings.join_before_host');
Mute_upon_entry := jResp.BoolOf('settings.mute_upon_entry');
Participant_video := jResp.BoolOf('settings.participant_video');
Registrants_confirmation_email := jResp.BoolOf('settings.registrants_confirmation_email');
Use_pmi := jResp.BoolOf('settings.use_pmi');
Waiting_room := jResp.BoolOf('settings.waiting_room');
Watermark := jResp.BoolOf('settings.watermark');
Registrants_email_notification := jResp.BoolOf('settings.registrants_email_notification');
start_time := jResp.StringOf('start_time');
start_url := jResp.StringOf('start_url');
status := jResp.StringOf('status');
timezone := jResp.StringOf('timezone');
topic := jResp.StringOf('topic');
v_type := jResp.IntOf('type');
uuid := jResp.StringOf('uuid');
i := 0;
count_i := jResp.SizeOfArray('settings.global_dial_in_countries');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('settings.global_dial_in_countries[i]');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('settings.global_dial_in_numbers');
while i < count_i do
begin
jResp.I := i;
city := jResp.StringOf('settings.global_dial_in_numbers[i].city');
country := jResp.StringOf('settings.global_dial_in_numbers[i].country');
country_name := jResp.StringOf('settings.global_dial_in_numbers[i].country_name');
v_number := jResp.StringOf('settings.global_dial_in_numbers[i].number');
v_type_str := jResp.StringOf('settings.global_dial_in_numbers[i].type');
i := i + 1;
end;
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": ""
}
]
}
