unicodeC / Zoom API / Add internal numbers
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkJsonArrayW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkHttpRequestW req;
HCkJsonArrayW jsonFormData1;
HCkJsonObjectW jsonObj_1;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *v_number;
const wchar_t *display_number;
const wchar_t *country;
int v_type;
const wchar_t *labels;
const wchar_t *languages;
BOOL visible;
BOOL allow_join;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
req = CkHttpRequestW_Create();
CkHttpRequestW_putHttpVerb(req,L"POST");
CkHttpRequestW_putPath(req,L"/v2/accounts/:accountId/sip_trunk/internal_numbers");
CkHttpRequestW_putContentType(req,L"multipart/form-data");
jsonFormData1 = CkJsonArrayW_Create();
CkJsonArrayW_AddObjectAt(jsonFormData1,-1);
jsonObj_1 = CkJsonArrayW_ObjectAt(jsonFormData1,CkJsonArrayW_getSize(jsonFormData1) - 1);
CkJsonObjectW_UpdateString(jsonObj_1,L"number",L"commodo magna");
CkJsonObjectW_UpdateString(jsonObj_1,L"display_number",L"in enim");
CkJsonObjectW_UpdateString(jsonObj_1,L"country",L"anim Excepteur cupidatat id");
CkJsonObjectW_UpdateInt(jsonObj_1,L"type",1);
CkJsonObjectW_UpdateString(jsonObj_1,L"labels",L"incididunt eiusmod sit");
CkJsonObjectW_UpdateString(jsonObj_1,L"languages",L"da-DK");
CkJsonObjectW_UpdateBool(jsonObj_1,L"visible",FALSE);
CkJsonObjectW_UpdateBool(jsonObj_1,L"allow_join",TRUE);
CkJsonObjectW_UpdateBool(jsonObj_1,L"allow_for_external_meetings",TRUE);
CkJsonObjectW_Dispose(jsonObj_1);
CkHttpRequestW_AddStringForUpload2(req,L"internal_numbers",L"",jsonFormData1,L"utf-8",L"application/json");
CkHttpRequestW_AddHeader(req,L"Authorization",L"Bearer <access_token>");
resp = CkHttpW_SynchronousRequest(http,L"api.zoom.us",443,TRUE,req);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
CkJsonArrayW_Dispose(jsonFormData1);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
CkJsonArrayW_Dispose(jsonFormData1);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"internal_numbers");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].id");
v_number = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].number");
display_number = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].display_number");
country = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].country");
v_type = CkJsonObjectW_IntOf(jResp,L"internal_numbers[i].type");
labels = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].labels");
languages = CkJsonObjectW_stringOf(jResp,L"internal_numbers[i].languages");
visible = CkJsonObjectW_BoolOf(jResp,L"internal_numbers[i].visible");
allow_join = CkJsonObjectW_BoolOf(jResp,L"internal_numbers[i].allow_join");
i = i + 1;
}
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
CkJsonArrayW_Dispose(jsonFormData1);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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": ""
}
]
}
