Chilkat Online Tools

VB.NET / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.zoom.us/v2/tsp",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim code As String
Dim v_number As String
Dim v_type As String

Dim tsp_provider As String = jResp.StringOf("tsp_provider")
Dim enable As Boolean = jResp.BoolOf("enable")
Dim tsp_enabled As Boolean = jResp.BoolOf("tsp_enabled")
Dim master_account_setting_extended As Boolean = jResp.BoolOf("master_account_setting_extended")
Dim modify_credential_forbidden As Boolean = jResp.BoolOf("modify_credential_forbidden")
Dim dial_in_number_unrestricted As Boolean = jResp.BoolOf("dial_in_number_unrestricted")
Dim tsp_bridge As String = jResp.StringOf("tsp_bridge")
Dim i As Integer = 0
Dim count_i As Integer = 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
End While

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