Chilkat Online Tools

unicodeC / Zoom API / Get account's TSP information

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *code;
    const wchar_t *v_number;
    const wchar_t *v_type;
    const wchar_t *tsp_provider;
    BOOL enable;
    BOOL tsp_enabled;
    BOOL master_account_setting_extended;
    BOOL modify_credential_forbidden;
    BOOL dial_in_number_unrestricted;
    const wchar_t *tsp_bridge;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

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

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.zoom.us/v2/tsp",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    tsp_provider = CkJsonObjectW_stringOf(jResp,L"tsp_provider");
    enable = CkJsonObjectW_BoolOf(jResp,L"enable");
    tsp_enabled = CkJsonObjectW_BoolOf(jResp,L"tsp_enabled");
    master_account_setting_extended = CkJsonObjectW_BoolOf(jResp,L"master_account_setting_extended");
    modify_credential_forbidden = CkJsonObjectW_BoolOf(jResp,L"modify_credential_forbidden");
    dial_in_number_unrestricted = CkJsonObjectW_BoolOf(jResp,L"dial_in_number_unrestricted");
    tsp_bridge = CkJsonObjectW_stringOf(jResp,L"tsp_bridge");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"dial_in_numbers");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        code = CkJsonObjectW_stringOf(jResp,L"dial_in_numbers[i].code");
        v_number = CkJsonObjectW_stringOf(jResp,L"dial_in_numbers[i].number");
        v_type = CkJsonObjectW_stringOf(jResp,L"dial_in_numbers[i].type");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_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}"
    }
  ]
}