PureBasic / Zoom API / Update account's TSP information
Back to Collection Items
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::setCkHttpVerb(req, "PATCH")
CkHttpRequest::setCkPath(req, "/v2/tsp")
CkHttpRequest::setCkContentType(req, "multipart/form-data")
CkHttpRequest::ckAddParam(req,"tsp_provider","Excepteur Duis")
CkHttpRequest::ckAddParam(req,"enable","Excepteur Duisfalse")
CkHttpRequest::ckAddParam(req,"tsp_enabled","Excepteur Duisfalsefalse")
CkHttpRequest::ckAddParam(req,"master_account_setting_extended","Excepteur Duisfalsefalsetrue")
CkHttpRequest::ckAddParam(req,"modify_credential_forbidden","Excepteur Duisfalsefalsetruefalse")
CkHttpRequest::ckAddParam(req,"dial_in_number_unrestricted","Excepteur Duisfalsefalsetruefalsefalse")
CkHttpRequest::ckAddParam(req,"tsp_bridge","Excepteur DuisfalsefalsetruefalsefalseUS_TSP_TB")
CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")
resp.i = CkHttp::ckSynchronousRequest(http,"api.zoom.us",443,1,req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndIf
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode <> 204
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Response Body:"
Debug CkHttpResponse::ckBodyStr(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
Debug "Success."
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'tsp_provider=Excepteur Duis'
--form 'enable=Excepteur Duisfalse'
--form 'tsp_enabled=Excepteur Duisfalsefalse'
--form 'master_account_setting_extended=Excepteur Duisfalsefalsetrue'
--form 'modify_credential_forbidden=Excepteur Duisfalsefalsetruefalse'
--form 'dial_in_number_unrestricted=Excepteur Duisfalsefalsetruefalsefalse'
--form 'tsp_bridge=Excepteur DuisfalsefalsetruefalsefalseUS_TSP_TB'
https://api.zoom.us/v2/tsp
Postman Collection Item JSON
{
"name": "Update account's TSP information",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "tsp_provider",
"value": "Excepteur Duis",
"description": "3rd party audio conferencing provider",
"type": "text"
},
{
"key": "enable",
"value": "false",
"description": "Enable 3rd party audio conferencing for account users",
"type": "text"
},
{
"key": "tsp_enabled",
"value": "false",
"description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
"type": "text"
},
{
"key": "master_account_setting_extended",
"value": "true",
"description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
"type": "text"
},
{
"key": "modify_credential_forbidden",
"value": "false",
"description": "Control restriction on account users being able to modify their TSP credentials.",
"type": "text"
},
{
"key": "dial_in_number_unrestricted",
"value": "false",
"description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
"type": "text"
},
{
"key": "tsp_bridge",
"value": "US_TSP_TB",
"description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"tsp"
]
},
"description": "Update information of the Telephony Service Provider set up on an account.<br>\n**Prerequisites**:<br>\nTSP account option should be enabled.<br>\n**Scopes:** `tsp:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n"
},
"response": [
{
"name": "**HTTP Status Code:** `204` **No Content**<br>\nTSP Account updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "tsp_provider",
"value": "Excepteur Duis",
"description": "3rd party audio conferencing provider",
"type": "text"
},
{
"key": "enable",
"value": "false",
"description": "Enable 3rd party audio conferencing for account users",
"type": "text"
},
{
"key": "tsp_enabled",
"value": "false",
"description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
"type": "text"
},
{
"key": "master_account_setting_extended",
"value": "true",
"description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
"type": "text"
},
{
"key": "modify_credential_forbidden",
"value": "false",
"description": "Control restriction on account users being able to modify their TSP credentials.",
"type": "text"
},
{
"key": "dial_in_number_unrestricted",
"value": "false",
"description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
"type": "text"
},
{
"key": "tsp_bridge",
"value": "US_TSP_TB",
"description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"tsp"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request.<br>\n\n**Error Code:** `300`<br>\nInvalid parameter: tsp_bridge.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "tsp_provider",
"value": "Excepteur Duis",
"description": "3rd party audio conferencing provider",
"type": "text"
},
{
"key": "enable",
"value": "false",
"description": "Enable 3rd party audio conferencing for account users",
"type": "text"
},
{
"key": "tsp_enabled",
"value": "false",
"description": "Enable TSP feature for account. This has to be enabled to use any other tsp settings/features.",
"type": "text"
},
{
"key": "master_account_setting_extended",
"value": "true",
"description": "For master account, extend its TSP setting to all sub accounts. For sub account, extend TSP setting from master account.",
"type": "text"
},
{
"key": "modify_credential_forbidden",
"value": "false",
"description": "Control restriction on account users being able to modify their TSP credentials.",
"type": "text"
},
{
"key": "dial_in_number_unrestricted",
"value": "false",
"description": "Control restriction on account users adding a TSP number outside of account's dial in numbers.",
"type": "text"
},
{
"key": "tsp_bridge",
"value": "US_TSP_TB",
"description": "Telephony bridge (This can only be one of US_TSP_TB,EU_TSP_TB)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/tsp",
"host": [
"{{baseUrl}}"
],
"path": [
"tsp"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
