Chilkat Online Tools

Swift / Zoom API / List webinars

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("type", value: "live")
    queryParams.UpdateString("from", value: "1989-05-07")
    queryParams.UpdateString("to", value: "1989-05-07")
    queryParams.UpdateInt("page_size", value: 30)
    queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/metrics/webinars", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "from": "string [date]",
    //   "to": "string [date]",
    //   "page_count": "integer",
    //   "page_size": "integer",
    //   "total_records": "integer",
    //   "next_page_token": "string",
    //   "webinars": [
    //     {
    //       "uuid": "string [uuid]",
    //       "id": "integer",
    //       "topic": "string",
    //       "host": "string",
    //       "email": "string",
    //       "user_type": "string",
    //       "start_time": "string [date-time]",
    //       "end_time": "string [date-time]",
    //       "duration": "string",
    //       "participants": "integer",
    //       "has_pstn": "boolean",
    //       "has_voip": "boolean",
    //       "has_3rd_party_audio": "boolean",
    //       "has_video": "boolean",
    //       "has_screen_share": "boolean",
    //       "has_recording": "boolean",
    //       "has_sip": "boolean",
    //       "has_archiving": "boolean"
    //     }
    //   ]
    // }

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

    var uuid: String?
    var id: String?
    var topic: String?
    var host: String?
    var email: String?
    var user_type: String?
    var start_time: String?
    var end_time: String?
    var duration: String?
    var participants: String?
    var has_pstn: String?
    var has_voip: String?
    var has_3rd_party_audio: String?
    var has_video: String?
    var has_screen_share: String?
    var has_recording: String?
    var has_sip: String?
    var has_archiving: String?

    var from: String? = jResp.StringOf("from")
    var v_to: String? = jResp.StringOf("to")
    var page_count: String? = jResp.StringOf("page_count")
    var page_size: String? = jResp.StringOf("page_size")
    var total_records: String? = jResp.StringOf("total_records")
    var next_page_token: String? = jResp.StringOf("next_page_token")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("webinars").intValue
    while i < count_i {
        jResp.I = i
        uuid = jResp.StringOf("webinars[i].uuid")
        id = jResp.StringOf("webinars[i].id")
        topic = jResp.StringOf("webinars[i].topic")
        host = jResp.StringOf("webinars[i].host")
        email = jResp.StringOf("webinars[i].email")
        user_type = jResp.StringOf("webinars[i].user_type")
        start_time = jResp.StringOf("webinars[i].start_time")
        end_time = jResp.StringOf("webinars[i].end_time")
        duration = jResp.StringOf("webinars[i].duration")
        participants = jResp.StringOf("webinars[i].participants")
        has_pstn = jResp.StringOf("webinars[i].has_pstn")
        has_voip = jResp.StringOf("webinars[i].has_voip")
        has_3rd_party_audio = jResp.StringOf("webinars[i].has_3rd_party_audio")
        has_video = jResp.StringOf("webinars[i].has_video")
        has_screen_share = jResp.StringOf("webinars[i].has_screen_share")
        has_recording = jResp.StringOf("webinars[i].has_recording")
        has_sip = jResp.StringOf("webinars[i].has_sip")
        has_archiving = jResp.StringOf("webinars[i].has_archiving")
        i = i + 1
    }


}

Curl Command

curl -G -d "type=live"
	-d "from=1989-05-07"
	-d "to=1989-05-07"
	-d "page_size=30"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/webinars

Postman Collection Item JSON

{
  "name": "List webinars",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "webinars"
      ],
      "query": [
        {
          "key": "type",
          "value": "live",
          "description": "The type of webinar to query: \n* `past` — All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`."
        },
        {
          "key": "from",
          "value": "1989-05-07",
          "description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
        },
        {
          "key": "to",
          "value": "1989-05-07",
          "description": "(Required) End date."
        },
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        },
        {
          "key": "next_page_token",
          "value": "quis officia in reprehenderit",
          "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
        }
      ]
    },
    "description": "List all the live or past webinars from a specified period of time. <br><br>\n**Scopes:** `dashboard_webinars:read:admin`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`<br>\n**Prerequisites:**<br>\n* Business, Education or API Plan with Webinar add-on.\n\n\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nMeetings returned.<br>\nOnly available for paid accounts that have enabled the Dashboard feature.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "webinars"
          ],
          "query": [
            {
              "key": "type",
              "value": "live"
            },
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"from\": \"string [date]\",\n \"to\": \"string [date]\",\n \"page_count\": \"integer\",\n \"page_size\": \"integer\",\n \"total_records\": \"integer\",\n \"next_page_token\": \"string\",\n \"webinars\": [\n  {\n   \"uuid\": \"string [uuid]\",\n   \"id\": \"integer\",\n   \"topic\": \"string\",\n   \"host\": \"string\",\n   \"email\": \"string\",\n   \"user_type\": \"string\",\n   \"start_time\": \"string [date-time]\",\n   \"end_time\": \"string [date-time]\",\n   \"duration\": \"string\",\n   \"participants\": \"integer\",\n   \"has_pstn\": \"boolean\",\n   \"has_voip\": \"boolean\",\n   \"has_3rd_party_audio\": \"boolean\",\n   \"has_video\": \"boolean\",\n   \"has_screen_share\": \"boolean\",\n   \"has_recording\": \"boolean\",\n   \"has_sip\": \"boolean\",\n   \"has_archiving\": \"boolean\"\n  }\n ]\n}"
    },
    {
      "name": "**Error Code:** `200`<br>\nThe next page token is invalid or has expired.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/webinars?type=live&from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "webinars"
          ],
          "query": [
            {
              "key": "type",
              "value": "live"
            },
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}