phpAx / Zoom API / Add internal numbers
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.HttpRequest')
$req = new COM("Chilkat.HttpRequest");
$req->HttpVerb = 'POST';
$req->Path = '/v2/accounts/:accountId/sip_trunk/internal_numbers';
$req->ContentType = 'multipart/form-data';
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonArray')
$jsonFormData1 = new COM("Chilkat.JsonArray");
$jsonFormData1->AddObjectAt(-1);
// jsonObj_1 is a Chilkat.JsonObject
$jsonObj_1 = $jsonFormData1->ObjectAt($jsonFormData1->Size - 1);
$jsonObj_1->UpdateString('number','commodo magna');
$jsonObj_1->UpdateString('display_number','in enim');
$jsonObj_1->UpdateString('country','anim Excepteur cupidatat id');
$jsonObj_1->UpdateInt('type',1);
$jsonObj_1->UpdateString('labels','incididunt eiusmod sit');
$jsonObj_1->UpdateString('languages','da-DK');
$jsonObj_1->UpdateBool('visible',0);
$jsonObj_1->UpdateBool('allow_join',1);
$jsonObj_1->UpdateBool('allow_for_external_meetings',1);
$req->AddStringForUpload2('internal_numbers','',$jsonFormData1,'utf-8','application/json');
$req->AddHeader('Authorization','Bearer <access_token>');
// resp is a Chilkat.HttpResponse
$resp = $http->SynchronousRequest('api.zoom.us',443,1,$req);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "internal_numbers": [
// {
// "id": "A26fhgdfg63",
// "number": "+16466661110",
// "display_number": "+1 646 666 1110",
// "country": "US",
// "type": 0,
// "labels": "SIP-Internal",
// "languages": "en-GB",
// "visible": true,
// "allow_join": true
// }
// ]
// }
// 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('internal_numbers');
while ($i < $count_i) {
$jResp->I = $i;
$id = $jResp->stringOf('internal_numbers[i].id');
$v_number = $jResp->stringOf('internal_numbers[i].number');
$display_number = $jResp->stringOf('internal_numbers[i].display_number');
$country = $jResp->stringOf('internal_numbers[i].country');
$v_type = $jResp->IntOf('internal_numbers[i].type');
$labels = $jResp->stringOf('internal_numbers[i].labels');
$languages = $jResp->stringOf('internal_numbers[i].languages');
$visible = $jResp->BoolOf('internal_numbers[i].visible');
$allow_join = $jResp->BoolOf('internal_numbers[i].allow_join');
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'internal_numbers=[{"number":"commodo magna","display_number":"in enim","country":"anim Excepteur cupidatat id","type":1,"labels":"incididunt eiusmod sit","languages":"da-DK","visible":false,"allow_join":true,"allow_for_external_meetings":true}]'
https://api.zoom.us/v2/accounts/:accountId/sip_trunk/internal_numbers
Postman Collection Item JSON
{
"name": "Add internal numbers",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "internal_numbers",
"value": "[{\"number\":\"commodo magna\",\"display_number\":\"in enim\",\"country\":\"anim Excepteur cupidatat id\",\"type\":1,\"labels\":\"incididunt eiusmod sit\",\"languages\":\"da-DK\",\"visible\":false,\"allow_join\":true,\"allow_for_external_meetings\":true}]",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/internal_numbers",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"internal_numbers"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the account.<br>To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter."
}
]
},
"description": "This API allows a master account with SIP Connected Audio plan to assign internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) to a master account or a sub account.<br><br>To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter.\n<br><b>Prerequisites:</b><br>\n* The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.<br><br>\n**Scope:** `sip_trunk:master`\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `201` **Created** <br>\nInternal numbers added successfully. \n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "internal_numbers",
"value": "[{\"number\":\"commodo magna\",\"display_number\":\"in enim\",\"country\":\"anim Excepteur cupidatat id\",\"type\":1,\"labels\":\"incididunt eiusmod sit\",\"languages\":\"da-DK\",\"visible\":false,\"allow_join\":true,\"allow_for_external_meetings\":true}]",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/internal_numbers",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"internal_numbers"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the account.<br>To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"internal_numbers\": [\n {\n \"id\": \"A26fhgdfg63\",\n \"number\": \"+16466661110\",\n \"display_number\": \"+1 646 666 1110\",\n \"country\": \"US\",\n \"type\": 0,\n \"labels\": \"SIP-Internal\",\n \"languages\": \"en-GB\",\n \"visible\": true,\n \"allow_join\": true\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300`<br> \n* Your account does not have the permission to make updates on this account. Only a master account can perform this action on a sub account.\n* Request failed because this account i",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "internal_numbers",
"value": "[{\"number\":\"commodo magna\",\"display_number\":\"in enim\",\"country\":\"anim Excepteur cupidatat id\",\"type\":1,\"labels\":\"incididunt eiusmod sit\",\"languages\":\"da-DK\",\"visible\":false,\"allow_join\":true,\"allow_for_external_meetings\":true}]",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/internal_numbers",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"internal_numbers"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the account.<br>To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter."
}
]
}
},
"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\n\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "internal_numbers",
"value": "[{\"number\":\"commodo magna\",\"display_number\":\"in enim\",\"country\":\"anim Excepteur cupidatat id\",\"type\":1,\"labels\":\"incididunt eiusmod sit\",\"languages\":\"da-DK\",\"visible\":false,\"allow_join\":true,\"allow_for_external_meetings\":true}]",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/sip_trunk/internal_numbers",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"sip_trunk",
"internal_numbers"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the account.<br>To add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
