Chilkat Online Tools

delphiAx / Zoom API / Get a webinar

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;
created_at: WideString;
duration: Integer;
host_id: WideString;
id: Integer;
join_url: WideString;
Allow_multiple_devices: Integer;
Alternative_hosts: WideString;
Approval_type: Integer;
Audio: WideString;
Auto_recording: WideString;
Close_registration: Integer;
Contact_email: WideString;
Contact_name: WideString;
Enforce_login: Integer;
Enforce_login_domains: WideString;
Hd_video: Integer;
Hd_video_for_attendees: Integer;
Send_1080p_video_to_attendees: Integer;
Host_video: Integer;
On_demand: Integer;
Panelists_video: Integer;
Practice_session: Integer;
Question_answer: Integer;
Registrants_confirmation_email: Integer;
Registrants_restrict_number: Integer;
Show_share_button: Integer;
Registrants_email_notification: Integer;
Email_language: WideString;
Panelists_invitation_email_notification: Integer;
Enable: Integer;
v_Type: Integer;
Follow_up_attendees_email_notificationEnable: Integer;
Follow_up_attendees_email_notificationType: Integer;
Follow_up_absentees_email_notificationEnable: Integer;
Follow_up_absentees_email_notificationType: Integer;
start_time: WideString;
start_url: 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/webinars/:webinarId',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)

// {
//   "created_at": "2019-09-13T15:35:00Z",
//   "duration": 60,
//   "host_id": "Labcjskdfsjgfg",
//   "id": 12345678,
//   "join_url": "https://zoom.us/j/12345678",
//   "settings": {
//     "allow_multiple_devices": true,
//     "alternative_hosts": "",
//     "approval_type": 2,
//     "audio": "both",
//     "auto_recording": "local",
//     "close_registration": true,
//     "contact_email": "example@example.com",
//     "contact_name": "Amal",
//     "enforce_login": false,
//     "enforce_login_domains": "",
//     "global_dial_in_countries": [
//       "US"
//     ],
//     "global_dial_in_numbers": [
//       {
//         "city": "New York",
//         "country": "US",
//         "country_name": "US",
//         "number": "+1 00000",
//         "type": "toll"
//       },
//       {
//         "city": "San Jose",
//         "country": "US",
//         "country_name": "US",
//         "number": "+1 111111111",
//         "type": "toll"
//       },
//       {
//         "city": "San Jose",
//         "country": "US",
//         "country_name": "US",
//         "number": "+1 11111110",
//         "type": "toll"
//       }
//     ],
//     "hd_video": false,
//     "hd_video_for_attendees": false,
//     "send_1080p_video_to_attendees": false,
//     "host_video": false,
//     "on_demand": false,
//     "panelists_video": false,
//     "practice_session": false,
//     "question_answer": true,
//     "registrants_confirmation_email": true,
//     "registrants_restrict_number": 0,
//     "show_share_button": true,
//     "registrants_email_notification": true,
//     "email_language": "en-US",
//     "panelists_invitation_email_notification": true,
//     "attendees_and_panelists_reminder_email_notification": {
//       "enable": true,
//       "type": 1
//     },
//     "follow_up_attendees_email_notification": {
//       "enable": true,
//       "type": 1
//     },
//     "follow_up_absentees_email_notification": {
//       "enable": true,
//       "type": 1
//     }
//   },
//   "start_time": "2019-08-30T22:00:00Z",
//   "start_url": "https://zoom.us/s/00000011110?zhghTlUT1Rjd2FXRgh0amxoejNQZ1EiLCJjaWQiOiIifQ.NJ0CXWQ-yhI8Xv01JvxityBtzp3Bt7odMOEG2L8DLmY",
//   "timezone": "America/New_York",
//   "topic": "Test Webinar",
//   "type": 5,
//   "uuid": "nWMHAAAAAAAAAAAAAUDP1A=="
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

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');
Allow_multiple_devices := jResp.BoolOf('settings.allow_multiple_devices');
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');
Contact_email := jResp.StringOf('settings.contact_email');
Contact_name := jResp.StringOf('settings.contact_name');
Enforce_login := jResp.BoolOf('settings.enforce_login');
Enforce_login_domains := jResp.StringOf('settings.enforce_login_domains');
Hd_video := jResp.BoolOf('settings.hd_video');
Hd_video_for_attendees := jResp.BoolOf('settings.hd_video_for_attendees');
Send_1080p_video_to_attendees := jResp.BoolOf('settings.send_1080p_video_to_attendees');
Host_video := jResp.BoolOf('settings.host_video');
On_demand := jResp.BoolOf('settings.on_demand');
Panelists_video := jResp.BoolOf('settings.panelists_video');
Practice_session := jResp.BoolOf('settings.practice_session');
Question_answer := jResp.BoolOf('settings.question_answer');
Registrants_confirmation_email := jResp.BoolOf('settings.registrants_confirmation_email');
Registrants_restrict_number := jResp.IntOf('settings.registrants_restrict_number');
Show_share_button := jResp.BoolOf('settings.show_share_button');
Registrants_email_notification := jResp.BoolOf('settings.registrants_email_notification');
Email_language := jResp.StringOf('settings.email_language');
Panelists_invitation_email_notification := jResp.BoolOf('settings.panelists_invitation_email_notification');
Enable := jResp.BoolOf('settings.attendees_and_panelists_reminder_email_notification.enable');
v_Type := jResp.IntOf('settings.attendees_and_panelists_reminder_email_notification.type');
Follow_up_attendees_email_notificationEnable := jResp.BoolOf('settings.follow_up_attendees_email_notification.enable');
Follow_up_attendees_email_notificationType := jResp.IntOf('settings.follow_up_attendees_email_notification.type');
Follow_up_absentees_email_notificationEnable := jResp.BoolOf('settings.follow_up_absentees_email_notification.enable');
Follow_up_absentees_email_notificationType := jResp.IntOf('settings.follow_up_absentees_email_notification.type');
start_time := jResp.StringOf('start_time');
start_url := jResp.StringOf('start_url');
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/webinars/:webinarId

Postman Collection Item JSON

{
  "name": "Get a webinar",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webinars",
        ":webinarId"
      ],
      "query": [
        {
          "key": "occurrence_id",
          "value": "quis officia in reprehenderit",
          "description": "Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [Create a Webinar API](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate), you can retrieve the Occurrence ID from the response of the API call."
        },
        {
          "key": "show_previous_occurrences",
          "value": "true",
          "description": "Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar."
        }
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The webinar's ID or universally unique ID (UUID)."
        }
      ]
    },
    "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.<br>Use this API to get details of a scheduled webinar.<br><br>\n**Scopes:** `webinar:read:admin` `webinar:read`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>**Prerequisites:**\n* Pro or higher plan with a Webinar Add-on."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nSuccess",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "show_previous_occurrences",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"created_at\": \"2019-09-13T15:35:00Z\",\n \"duration\": 60,\n \"host_id\": \"Labcjskdfsjgfg\",\n \"id\": 12345678,\n \"join_url\": \"https://zoom.us/j/12345678\",\n \"settings\": {\n  \"allow_multiple_devices\": true,\n  \"alternative_hosts\": \"\",\n  \"approval_type\": 2,\n  \"audio\": \"both\",\n  \"auto_recording\": \"local\",\n  \"close_registration\": true,\n  \"contact_email\": \"example@example.com\",\n  \"contact_name\": \"Amal\",\n  \"enforce_login\": false,\n  \"enforce_login_domains\": \"\",\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 00000\",\n    \"type\": \"toll\"\n   },\n   {\n    \"city\": \"San Jose\",\n    \"country\": \"US\",\n    \"country_name\": \"US\",\n    \"number\": \"+1 111111111\",\n    \"type\": \"toll\"\n   },\n   {\n    \"city\": \"San Jose\",\n    \"country\": \"US\",\n    \"country_name\": \"US\",\n    \"number\": \"+1 11111110\",\n    \"type\": \"toll\"\n   }\n  ],\n  \"hd_video\": false,\n  \"hd_video_for_attendees\": false,\n  \"send_1080p_video_to_attendees\": false,\n  \"host_video\": false,\n  \"on_demand\": false,\n  \"panelists_video\": false,\n  \"practice_session\": false,\n  \"question_answer\": true,\n  \"registrants_confirmation_email\": true,\n  \"registrants_restrict_number\": 0,\n  \"show_share_button\": true,\n  \"registrants_email_notification\": true,\n  \"email_language\": \"en-US\",\n  \"panelists_invitation_email_notification\": true,\n  \"attendees_and_panelists_reminder_email_notification\": {\n   \"enable\": true,\n   \"type\": 1\n  },\n  \"follow_up_attendees_email_notification\": {\n   \"enable\": true,\n   \"type\": 1\n  },\n  \"follow_up_absentees_email_notification\": {\n   \"enable\": true,\n   \"type\": 1\n  }\n },\n \"start_time\": \"2019-08-30T22:00:00Z\",\n \"start_url\": \"https://zoom.us/s/00000011110?zhghTlUT1Rjd2FXRgh0amxoejNQZ1EiLCJjaWQiOiIifQ.NJ0CXWQ-yhI8Xv01JvxityBtzp3Bt7odMOEG2L8DLmY\",\n \"timezone\": \"America/New_York\",\n \"topic\": \"Test Webinar\",\n \"type\": 5,\n \"uuid\": \"nWMHAAAAAAAAAAAAAUDP1A==\"\n}"
    },
    {
      "name": "**HTTP Status Code:** `300`<br>Invalid webinar ID.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "show_previous_occurrences",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID)."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "show_previous_occurrences",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID)."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nWebinar not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3001`<br>\nWebinar {webinarId} not found or has expired.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId?occurrence_id=quis officia in reprehenderit&show_previous_occurrences=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "show_previous_occurrences",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID)."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}