Chilkat Online Tools

Swift3 / Zoom API / List H.323/SIP devices

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.updateInt("page_size", value: 30)
    queryParams.updateInt("page_number", value: 1)
    queryParams.update("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/h323/devices", 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_number": 1,
    //   "page_size": 1,
    //   "total_records": 1,
    //   "devices": [
    //     {
    //       "id": "abceHewahkrehwiK",
    //       "name": "api_test_20190508",
    //       "protocol": "H.323",
    //       "ip": "127.0.0.1",
    //       "encryption": "auto"
    //     }
    //   ]
    // }

    // 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 name: String?
    var protocol: String?
    var ip: String?
    var encryption: String?

    var page_count: Int = jResp.int(of: "page_count").intValue
    var page_number: Int = jResp.int(of: "page_number").intValue
    var page_size: Int = jResp.int(of: "page_size").intValue
    var total_records: Int = jResp.int(of: "total_records").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "devices").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "devices[i].id")
        name = jResp.string(of: "devices[i].name")
        protocol = jResp.string(of: "devices[i].protocol")
        ip = jResp.string(of: "devices[i].ip")
        encryption = jResp.string(of: "devices[i].encryption")
        i = i + 1
    }


}

Curl Command

curl -G -d "page_size=30"
	-d "page_number=1"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/h323/devices

Postman Collection Item JSON

{
  "name": "List H.323/SIP devices",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/h323/devices?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "h323",
        "devices"
      ],
      "query": [
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        },
        {
          "key": "page_number",
          "value": "1",
          "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
        },
        {
          "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": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.<br><br>\n**Scopes:** `h323:read:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nList of H.323/SIP devices returned.<br>\n**Error Code:** `200`<br>\nNo permission.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/h323/devices?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "h323",
            "devices"
          ],
          "query": [
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "page_number",
              "value": "1"
            },
            {
              "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 \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 1,\n \"total_records\": 1,\n \"devices\": [\n  {\n   \"id\": \"abceHewahkrehwiK\",\n   \"name\": \"api_test_20190508\",\n   \"protocol\": \"H.323\",\n   \"ip\": \"127.0.0.1\",\n   \"encryption\": \"auto\"\n  }\n ]\n}"
    }
  ]
}