Powershell / Zoom API / Get account's TSP information
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.zoom.us/v2/tsp",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
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
$tsp_provider = $jResp.StringOf("tsp_provider")
$enable = $jResp.BoolOf("enable")
$tsp_enabled = $jResp.BoolOf("tsp_enabled")
$master_account_setting_extended = $jResp.BoolOf("master_account_setting_extended")
$modify_credential_forbidden = $jResp.BoolOf("modify_credential_forbidden")
$dial_in_number_unrestricted = $jResp.BoolOf("dial_in_number_unrestricted")
$tsp_bridge = $jResp.StringOf("tsp_bridge")
$i = 0
$count_i = $jResp.SizeOfArray("dial_in_numbers")
while ($i -lt $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}"
}
]
}