TCL / Zoom API / Assign SIP trunks
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]
set req [new_CkHttpRequest]
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/v2/accounts/:accountId/sip_trunk/trunks"
CkHttpRequest_put_ContentType $req "multipart/form-data"
set jsonFormData1 [new_CkJsonArray]
CkJsonArray_AddObjectAt $jsonFormData1 -1
# jsonObj_1 is a CkJsonObject
set jsonObj_1 [CkJsonArray_ObjectAt $jsonFormData1 [expr [CkJsonArray_get_Size $jsonFormData1] - 1]]
CkJsonObject_UpdateString $jsonObj_1 "id" "amet in"
CkJsonObject_UpdateString $jsonObj_1 "dnis" "quis re"
CkJsonObject_UpdateString $jsonObj_1 "outbound_caller_id" "veniam"
delete_CkJsonObject $jsonObj_1
CkHttpRequest_AddStringForUpload2 $req "sip_trunks" "" $jsonFormData1 "utf-8" "application/json"
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "api.zoom.us" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonArray $jsonFormData1
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonArray $jsonFormData1
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "sip_trunks": [
# {
# "id": "represdf324fe",
# "name": "HQ-trunk",
# "sip_server_address": "1.11.123.123",
# "dnis": "dolore43tr4u",
# "number_prefix": "0"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "sip_trunks"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "sip_trunks[i].id"]
set name [CkJsonObject_stringOf $jResp "sip_trunks[i].name"]
set sip_server_address [CkJsonObject_stringOf $jResp "sip_trunks[i].sip_server_address"]
set dnis [CkJsonObject_stringOf $jResp "sip_trunks[i].dnis"]
set number_prefix [CkJsonObject_stringOf $jResp "sip_trunks[i].number_prefix"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonArray $jsonFormData1
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'sip_trunks=[{"id":"amet in","dnis":"quis re","outbound_caller_id":"veniam"}]'
https://api.zoom.us/v2/accounts/:accountId/sip_trunk/trunks
Postman Collection Item JSON
{
"name": "Assign SIP trunks",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sip_trunks",
"value": "[{\"id\":\"amet in\",\"dnis\":\"quis re\",\"outbound_caller_id\":\"veniam\"}]",
"description": "Array of one or more SIP Trunk objects. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/trunks",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"trunks"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the sub account."
}
]
},
"description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers’ IP telephony network, will be connected over this trunk rather than over the PSTN.<br><br>Use this API to assign SIP trunk(s) that are available on a master account to a sub account. <br><b>Prerequisites:</b><br>\n* The account making this API request must be a master account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.<br><br>\n**Scope:** `sip_trunk:master`"
},
"response": [
{
"name": "**HTTP Status Code:** `204` **No Content**<br>\nSIP Trunk assigned successfully.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sip_trunks",
"value": "[{\"id\":\"amet in\",\"dnis\":\"quis re\",\"outbound_caller_id\":\"veniam\"}]",
"description": "Array of one or more SIP Trunk objects. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/trunks",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"trunks"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the sub account."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"sip_trunks\": [\n {\n \"id\": \"represdf324fe\",\n \"name\": \"HQ-trunk\",\n \"sip_server_address\": \"1.11.123.123\",\n \"dnis\": \"dolore43tr4u\",\n \"number_prefix\": \"0\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300`<br> \n* Request failed because this account is not enrolled in SIP Connected Audio plan.<br>\n* The master account has no sip trunk configs.<br>\n* Invalid parameter: sip_trunks.\n\n\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sip_trunks",
"value": "[{\"id\":\"amet in\",\"dnis\":\"quis re\",\"outbound_caller_id\":\"veniam\"}]",
"description": "Array of one or more SIP Trunk objects. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/trunks",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"trunks"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the sub account."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `2001`<br> Account does not exist: {0}.\n\n\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sip_trunks",
"value": "[{\"id\":\"amet in\",\"dnis\":\"quis re\",\"outbound_caller_id\":\"veniam\"}]",
"description": "Array of one or more SIP Trunk objects. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/trunks",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"trunks"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the sub account."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
