Chilkat Online Tools

PowerBuilder / Zoom API / Get a meeting

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_City
string ls_Country
string ls_Country_name
string ls_V_number
string ls_V_type_str
string ls_Agenda
string ls_Created_at
integer li_Duration
string ls_Host_id
integer li_Id
string ls_Join_url
string ls_Alternative_hosts
integer li_Approval_type
string ls_Audio
string ls_Auto_recording
integer li_Close_registration
integer li_Cn_meeting
integer li_Enforce_login
string ls_Enforce_login_domains
integer li_Host_video
integer li_In_meeting
integer li_Join_before_host
integer li_Mute_upon_entry
integer li_Participant_video
integer li_Registrants_confirmation_email
integer li_Use_pmi
integer li_Waiting_room
integer li_Watermark
integer li_Registrants_email_notification
string ls_Start_time
string ls_Start_url
string ls_Status
string ls_Timezone
string ls_Topic
integer li_V_type
string ls_Uuid
integer i
integer li_Count_i

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("occurrence_id","quis officia in reprehenderit")
loo_QueryParams.UpdateString("show_previous_occurrences","true")

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"

loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/meetings/:meetingId",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_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

ls_Agenda = loo_JResp.StringOf("agenda")
ls_Created_at = loo_JResp.StringOf("created_at")
li_Duration = loo_JResp.IntOf("duration")
ls_Host_id = loo_JResp.StringOf("host_id")
li_Id = loo_JResp.IntOf("id")
ls_Join_url = loo_JResp.StringOf("join_url")
ls_Alternative_hosts = loo_JResp.StringOf("settings.alternative_hosts")
li_Approval_type = loo_JResp.IntOf("settings.approval_type")
ls_Audio = loo_JResp.StringOf("settings.audio")
ls_Auto_recording = loo_JResp.StringOf("settings.auto_recording")
li_Close_registration = loo_JResp.BoolOf("settings.close_registration")
li_Cn_meeting = loo_JResp.BoolOf("settings.cn_meeting")
li_Enforce_login = loo_JResp.BoolOf("settings.enforce_login")
ls_Enforce_login_domains = loo_JResp.StringOf("settings.enforce_login_domains")
li_Host_video = loo_JResp.BoolOf("settings.host_video")
li_In_meeting = loo_JResp.BoolOf("settings.in_meeting")
li_Join_before_host = loo_JResp.BoolOf("settings.join_before_host")
li_Mute_upon_entry = loo_JResp.BoolOf("settings.mute_upon_entry")
li_Participant_video = loo_JResp.BoolOf("settings.participant_video")
li_Registrants_confirmation_email = loo_JResp.BoolOf("settings.registrants_confirmation_email")
li_Use_pmi = loo_JResp.BoolOf("settings.use_pmi")
li_Waiting_room = loo_JResp.BoolOf("settings.waiting_room")
li_Watermark = loo_JResp.BoolOf("settings.watermark")
li_Registrants_email_notification = loo_JResp.BoolOf("settings.registrants_email_notification")
ls_Start_time = loo_JResp.StringOf("start_time")
ls_Start_url = loo_JResp.StringOf("start_url")
ls_Status = loo_JResp.StringOf("status")
ls_Timezone = loo_JResp.StringOf("timezone")
ls_Topic = loo_JResp.StringOf("topic")
li_V_type = loo_JResp.IntOf("type")
ls_Uuid = loo_JResp.StringOf("uuid")
i = 0
li_Count_i = loo_JResp.SizeOfArray("settings.global_dial_in_countries")
do while i < li_Count_i
    loo_JResp.I = i
    ls_StrVal = loo_JResp.StringOf("settings.global_dial_in_countries[i]")
    i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("settings.global_dial_in_numbers")
do while i < li_Count_i
    loo_JResp.I = i
    ls_City = loo_JResp.StringOf("settings.global_dial_in_numbers[i].city")
    ls_Country = loo_JResp.StringOf("settings.global_dial_in_numbers[i].country")
    ls_Country_name = loo_JResp.StringOf("settings.global_dial_in_numbers[i].country_name")
    ls_V_number = loo_JResp.StringOf("settings.global_dial_in_numbers[i].number")
    ls_V_type_str = loo_JResp.StringOf("settings.global_dial_in_numbers[i].type")
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp

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": ""
    }
  ]
}