Chilkat Online Tools

delphiDll / Zoom API / Get account's TSP information

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
code: PWideChar;
v_number: PWideChar;
v_type: PWideChar;
tsp_provider: PWideChar;
enable: Boolean;
tsp_enabled: Boolean;
master_account_setting_extended: Boolean;
modify_credential_forbidden: Boolean;
dial_in_number_unrestricted: Boolean;
tsp_bridge: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.zoom.us/v2/tsp',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

tsp_provider := CkJsonObject__stringOf(jResp,'tsp_provider');
enable := CkJsonObject_BoolOf(jResp,'enable');
tsp_enabled := CkJsonObject_BoolOf(jResp,'tsp_enabled');
master_account_setting_extended := CkJsonObject_BoolOf(jResp,'master_account_setting_extended');
modify_credential_forbidden := CkJsonObject_BoolOf(jResp,'modify_credential_forbidden');
dial_in_number_unrestricted := CkJsonObject_BoolOf(jResp,'dial_in_number_unrestricted');
tsp_bridge := CkJsonObject__stringOf(jResp,'tsp_bridge');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'dial_in_numbers');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    code := CkJsonObject__stringOf(jResp,'dial_in_numbers[i].code');
    v_number := CkJsonObject__stringOf(jResp,'dial_in_numbers[i].number');
    v_type := CkJsonObject__stringOf(jResp,'dial_in_numbers[i].type');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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}"
    }
  ]
}