Perl / Zoom API / Assign SIP trunks
Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
$req->put_Path("/v2/accounts/:accountId/sip_trunk/trunks");
$req->put_ContentType("multipart/form-data");
$jsonFormData1 = chilkat::CkJsonArray->new();
$jsonFormData1->AddObjectAt(-1);
# jsonObj_1 is a JsonObject
$jsonObj_1 = $jsonFormData1->ObjectAt($jsonFormData1->get_Size() - 1);
$jsonObj_1->UpdateString("id","amet in");
$jsonObj_1->UpdateString("dnis","quis re");
$jsonObj_1->UpdateString("outbound_caller_id","veniam");
$req->AddStringForUpload2("sip_trunks","",$jsonFormData1,"utf-8","application/json");
$req->AddHeader("Authorization","Bearer <access_token>");
# resp is a HttpResponse
$resp = $http->SynchronousRequest("api.zoom.us",443,1,$req);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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
$i = 0;
$count_i = $jResp->SizeOfArray("sip_trunks");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf("sip_trunks[i].id");
$name = $jResp->stringOf("sip_trunks[i].name");
$sip_server_address = $jResp->stringOf("sip_trunks[i].sip_server_address");
$dnis = $jResp->stringOf("sip_trunks[i].dnis");
$number_prefix = $jResp->stringOf("sip_trunks[i].number_prefix");
$i = $i + 1;
}
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": ""
}
]
}
