Chilkat Online Tools

Swift / Zoom API / Get account's TSP information

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

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.zoom.us/v2/tsp", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

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

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

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    // {
    //   "tsp_provider": "someprovidername",
    //   "enable": true,
    //   "dial_in_numbers": [
    //     {
    //       "code": "111",
    //       "number": "000000000",
    //       "type": "toll"
    //     }
    //   ],
    //   "tsp_enabled": true,
    //   "master_account_setting_extended": false,
    //   "modify_credential_forbidden": true,
    //   "dial_in_number_unrestricted": false,
    //   "tsp_bridge": "string"
    // }

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

    var code: String?
    var v_number: String?
    var v_type: String?

    var tsp_provider: String? = jResp.StringOf("tsp_provider")
    var enable: Bool = jResp.BoolOf("enable")
    var tsp_enabled: Bool = jResp.BoolOf("tsp_enabled")
    var master_account_setting_extended: Bool = jResp.BoolOf("master_account_setting_extended")
    var modify_credential_forbidden: Bool = jResp.BoolOf("modify_credential_forbidden")
    var dial_in_number_unrestricted: Bool = jResp.BoolOf("dial_in_number_unrestricted")
    var tsp_bridge: String? = jResp.StringOf("tsp_bridge")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("dial_in_numbers").intValue
    while i < count_i {
        jResp.I = i
        code = jResp.StringOf("dial_in_numbers[i].code")
        v_number = jResp.StringOf("dial_in_numbers[i].number")
        v_type = jResp.StringOf("dial_in_numbers[i].type")
        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/tsp

Postman Collection Item JSON

{
  "name": "Get account's TSP information",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/tsp",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tsp"
      ]
    },
    "description": "Get information on Telephony Service Provider on an account level.<br><br>\n**Scopes:** `tsp:read:admin` <br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n**Prerequisites:**<br>\n* A Pro or a higher plan."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nTSP account detail returned successfully.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/tsp",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tsp"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"tsp_provider\": \"someprovidername\",\n \"enable\": true,\n \"dial_in_numbers\": [\n  {\n   \"code\": \"111\",\n   \"number\": \"000000000\",\n   \"type\": \"toll\"\n  }\n ],\n \"tsp_enabled\": true,\n \"master_account_setting_extended\": false,\n \"modify_credential_forbidden\": true,\n \"dial_in_number_unrestricted\": false,\n \"tsp_bridge\": \"string\"\n}"
    }
  ]
}