Chilkat Online Tools

Mono / Zoom API / Get account's TSP information

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://api.zoom.us/v2/tsp",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("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

string code;
string v_number;
string v_type;

string tsp_provider = jResp.StringOf("tsp_provider");
bool enable = jResp.BoolOf("enable");
bool tsp_enabled = jResp.BoolOf("tsp_enabled");
bool master_account_setting_extended = jResp.BoolOf("master_account_setting_extended");
bool modify_credential_forbidden = jResp.BoolOf("modify_credential_forbidden");
bool dial_in_number_unrestricted = jResp.BoolOf("dial_in_number_unrestricted");
string tsp_bridge = jResp.StringOf("tsp_bridge");
int i = 0;
int count_i = jResp.SizeOfArray("dial_in_numbers");
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}"
    }
  ]
}