delphiDll / Zoom API / Add internal numbers
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
jsonFormData1: HCkJsonArray;
jsonObj_1: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
v_number: PWideChar;
display_number: PWideChar;
country: PWideChar;
v_type: Integer;
labels: PWideChar;
languages: PWideChar;
visible: Boolean;
allow_join: Boolean;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/v2/accounts/:accountId/sip_trunk/internal_numbers');
CkHttpRequest_putContentType(req,'multipart/form-data');
jsonFormData1 := CkJsonArray_Create();
CkJsonArray_AddObjectAt(jsonFormData1,-1);
jsonObj_1 := CkJsonArray_ObjectAt(jsonFormData1,CkJsonArray_getSize(jsonFormData1) - 1);
CkJsonObject_UpdateString(jsonObj_1,'number','commodo magna');
CkJsonObject_UpdateString(jsonObj_1,'display_number','in enim');
CkJsonObject_UpdateString(jsonObj_1,'country','anim Excepteur cupidatat id');
CkJsonObject_UpdateInt(jsonObj_1,'type',1);
CkJsonObject_UpdateString(jsonObj_1,'labels','incididunt eiusmod sit');
CkJsonObject_UpdateString(jsonObj_1,'languages','da-DK');
CkJsonObject_UpdateBool(jsonObj_1,'visible',False);
CkJsonObject_UpdateBool(jsonObj_1,'allow_join',True);
CkJsonObject_UpdateBool(jsonObj_1,'allow_for_external_meetings',True);
CkJsonObject_Dispose(jsonObj_1);
CkHttpRequest_AddParam(req,'internal_numbers',CkJsonArray__emit(jsonFormData1));
CkHttpRequest_AddHeader(req,'Authorization','Bearer <access_token>');
resp := CkHttp_SynchronousRequest(http,'api.zoom.us',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkJsonObject_SizeOfArray(jResp,'internal_numbers');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'internal_numbers[i].id');
v_number := CkJsonObject__stringOf(jResp,'internal_numbers[i].number');
display_number := CkJsonObject__stringOf(jResp,'internal_numbers[i].display_number');
country := CkJsonObject__stringOf(jResp,'internal_numbers[i].country');
v_type := CkJsonObject_IntOf(jResp,'internal_numbers[i].type');
labels := CkJsonObject__stringOf(jResp,'internal_numbers[i].labels');
languages := CkJsonObject__stringOf(jResp,'internal_numbers[i].languages');
visible := CkJsonObject_BoolOf(jResp,'internal_numbers[i].visible');
allow_join := CkJsonObject_BoolOf(jResp,'internal_numbers[i].allow_join');
i := i + 1;
end;
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonArray_Dispose(jsonFormData1);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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": ""
}
]
}
