Chilkat Online Tools

Swift3 / Zoom API / Get webinar participants

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.update("type", value: "live")
    queryParams.updateInt("page_size", value: 30)
    queryParams.update("next_page_token", value: "quis officia in reprehenderit")
    queryParams.update("include_fields", value: "registrant_id")

    // 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/:webinarId/participants", 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)

    // {
    //   "page_count": 1,
    //   "page_size": 30,
    //   "total_records": 1,
    //   "next_page_token": "",
    //   "participants": [
    //     {
    //       "id": "d52f19c548b88490b5d16fcbd38",
    //       "user_id": "32dsfsd4g5gd",
    //       "user_name": "dojo",
    //       "device": "WIN",
    //       "ip_address": "127.0.0.1",
    //       "location": "New York",
    //       "network_type": "Wired",
    //       "microphone": "Plantronics BT600",
    //       "camera": "FaceTime HD Camera",
    //       "speaker": "Plantronics BT600",
    //       "data_center": "SC",
    //       "full_data_center": "United States;United States (US03_SC CRC)",
    //       "connection_type": "P2P",
    //       "join_time": "2019-09-07T13:15:02.837Z",
    //       "leave_time": "2019-09-07T13:15:09.837Z",
    //       "share_application": false,
    //       "share_desktop": true,
    //       "share_whiteboard": true,
    //       "recording": false,
    //       "status": "in_waiting_room",
    //       "pc_name": "dojo's pc",
    //       "domain": "Dojo-workspace",
    //       "mac_addr": " 00:0a:95:9d:68:16",
    //       "harddisk_id": "sed proident in",
    //       "version": "4.4.55383.0716",
    //       "leave_reason": "Dojo left the meeting.<br>Reason: Host ended the meeting.",
    //       "sip_uri": "sip:sipp@10.100.112.140:11029",
    //       "from_sip_uri": "sip:sipp@10.100.112.140:11029",
    //       "role": "panelist"
    //     }
    //   ]
    // }

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

    var id: String?
    var user_id: String?
    var user_name: String?
    var device: String?
    var ip_address: String?
    var location: String?
    var network_type: String?
    var microphone: String?
    var camera: String?
    var speaker: String?
    var data_center: String?
    var full_data_center: String?
    var connection_type: String?
    var join_time: String?
    var leave_time: String?
    var share_application: Bool
    var share_desktop: Bool
    var share_whiteboard: Bool
    var recording: Bool
    var status: String?
    var pc_name: String?
    var domain: String?
    var mac_addr: String?
    var harddisk_id: String?
    var version: String?
    var leave_reason: String?
    var sip_uri: String?
    var from_sip_uri: String?
    var role: String?

    var page_count: Int = jResp.int(of: "page_count").intValue
    var page_size: Int = jResp.int(of: "page_size").intValue
    var total_records: Int = jResp.int(of: "total_records").intValue
    var next_page_token: String? = jResp.string(of: "next_page_token")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "participants").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "participants[i].id")
        user_id = jResp.string(of: "participants[i].user_id")
        user_name = jResp.string(of: "participants[i].user_name")
        device = jResp.string(of: "participants[i].device")
        ip_address = jResp.string(of: "participants[i].ip_address")
        location = jResp.string(of: "participants[i].location")
        network_type = jResp.string(of: "participants[i].network_type")
        microphone = jResp.string(of: "participants[i].microphone")
        camera = jResp.string(of: "participants[i].camera")
        speaker = jResp.string(of: "participants[i].speaker")
        data_center = jResp.string(of: "participants[i].data_center")
        full_data_center = jResp.string(of: "participants[i].full_data_center")
        connection_type = jResp.string(of: "participants[i].connection_type")
        join_time = jResp.string(of: "participants[i].join_time")
        leave_time = jResp.string(of: "participants[i].leave_time")
        share_application = jResp.bool(of: "participants[i].share_application")
        share_desktop = jResp.bool(of: "participants[i].share_desktop")
        share_whiteboard = jResp.bool(of: "participants[i].share_whiteboard")
        recording = jResp.bool(of: "participants[i].recording")
        status = jResp.string(of: "participants[i].status")
        pc_name = jResp.string(of: "participants[i].pc_name")
        domain = jResp.string(of: "participants[i].domain")
        mac_addr = jResp.string(of: "participants[i].mac_addr")
        harddisk_id = jResp.string(of: "participants[i].harddisk_id")
        version = jResp.string(of: "participants[i].version")
        leave_reason = jResp.string(of: "participants[i].leave_reason")
        sip_uri = jResp.string(of: "participants[i].sip_uri")
        from_sip_uri = jResp.string(of: "participants[i].from_sip_uri")
        role = jResp.string(of: "participants[i].role")
        i = i + 1
    }


}

Curl Command

curl -G -d "type=live"
	-d "page_size=30"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-d "include_fields=registrant_id"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/webinars/:webinarId/participants

Postman Collection Item JSON

{
  "name": "Get webinar participants",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=registrant_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "webinars",
        ":webinarId",
        "participants"
      ],
      "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": "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."
        },
        {
          "key": "include_fields",
          "value": "registrant_id",
          "description": "Additional fields to include in the query: \n* `registrant_id` — Include the webinar registrant's ID. The registrant ID is the [webinar registrant's unique ID](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrants)."
        }
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
        }
      ]
    },
    "description": "Use this API to return information about participants from live or past webinars. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://marketplace.zoom.us/docs/api-reference/other-references/legacy-business-associate-agreements). \n\n**Scopes:** `dashboard_webinars:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nWebinar participants returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=registrant_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "webinars",
            ":webinarId",
            "participants"
          ],
          "query": [
            {
              "key": "type",
              "value": "live"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "include_fields",
              "value": "registrant_id"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"next_page_token\": \"\",\n \"participants\": [\n  {\n   \"id\": \"d52f19c548b88490b5d16fcbd38\",\n   \"user_id\": \"32dsfsd4g5gd\",\n   \"user_name\": \"dojo\",\n   \"device\": \"WIN\",\n   \"ip_address\": \"127.0.0.1\",\n   \"location\": \"New York\",\n   \"network_type\": \"Wired\",\n   \"microphone\": \"Plantronics BT600\",\n   \"camera\": \"FaceTime HD Camera\",\n   \"speaker\": \"Plantronics BT600\",\n   \"data_center\": \"SC\",\n   \"full_data_center\": \"United States;United States (US03_SC CRC)\",\n   \"connection_type\": \"P2P\",\n   \"join_time\": \"2019-09-07T13:15:02.837Z\",\n   \"leave_time\": \"2019-09-07T13:15:09.837Z\",\n   \"share_application\": false,\n   \"share_desktop\": true,\n   \"share_whiteboard\": true,\n   \"recording\": false,\n   \"status\": \"in_waiting_room\",\n   \"pc_name\": \"dojo's pc\",\n   \"domain\": \"Dojo-workspace\",\n   \"mac_addr\": \" 00:0a:95:9d:68:16\",\n   \"harddisk_id\": \"sed proident in\",\n   \"version\": \"4.4.55383.0716\",\n   \"leave_reason\": \"Dojo left the meeting.<br>Reason: Host ended the meeting.\",\n   \"sip_uri\": \"sip:sipp@10.100.112.140:11029\",\n   \"from_sip_uri\": \"sip:sipp@10.100.112.140:11029\",\n   \"role\": \"panelist\"\n  }\n ]\n}"
    },
    {
      "name": "**Error Code:** `300`<br>\nCan not access webinar info, {webinarId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=registrant_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "webinars",
            ":webinarId",
            "participants"
          ],
          "query": [
            {
              "key": "type",
              "value": "live"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "include_fields",
              "value": "registrant_id"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `3001`<br>\nThis webinar's detail info is not available or ID is not valid.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=registrant_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "webinars",
            ":webinarId",
            "participants"
          ],
          "query": [
            {
              "key": "type",
              "value": "live"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "include_fields",
              "value": "registrant_id"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}