TCL / Zoom API / Get account's TSP information
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.zoom.us/v2/tsp" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set tsp_provider [CkJsonObject_stringOf $jResp "tsp_provider"]
set enable [CkJsonObject_BoolOf $jResp "enable"]
set tsp_enabled [CkJsonObject_BoolOf $jResp "tsp_enabled"]
set master_account_setting_extended [CkJsonObject_BoolOf $jResp "master_account_setting_extended"]
set modify_credential_forbidden [CkJsonObject_BoolOf $jResp "modify_credential_forbidden"]
set dial_in_number_unrestricted [CkJsonObject_BoolOf $jResp "dial_in_number_unrestricted"]
set tsp_bridge [CkJsonObject_stringOf $jResp "tsp_bridge"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "dial_in_numbers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set code [CkJsonObject_stringOf $jResp "dial_in_numbers[i].code"]
set v_number [CkJsonObject_stringOf $jResp "dial_in_numbers[i].number"]
set v_type [CkJsonObject_stringOf $jResp "dial_in_numbers[i].type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
}
]
}