Foxpro / Zoom API / Add internal numbers
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loReq
LOCAL loJsonFormData1
LOCAL loJsonObj_1
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_number
LOCAL lcDisplay_number
LOCAL lcCountry
LOCAL lnV_type
LOCAL lcLabels
LOCAL lcLanguages
LOCAL lnVisible
LOCAL lnAllow_join
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loReq = CreateObject('Chilkat_9_5_0.HttpRequest')
loReq.HttpVerb = "POST"
loReq.Path = "/v2/accounts/:accountId/sip_trunk/internal_numbers"
loReq.ContentType = "multipart/form-data"
loJsonFormData1 = CreateObject('Chilkat_9_5_0.JsonArray')
loJsonFormData1.AddObjectAt(-1)
loJsonObj_1 = loJsonFormData1.ObjectAt(loJsonFormData1.Size - 1)
loJsonObj_1.UpdateString("number","commodo magna")
loJsonObj_1.UpdateString("display_number","in enim")
loJsonObj_1.UpdateString("country","anim Excepteur cupidatat id")
loJsonObj_1.UpdateInt("type",1)
loJsonObj_1.UpdateString("labels","incididunt eiusmod sit")
loJsonObj_1.UpdateString("languages","da-DK")
loJsonObj_1.UpdateBool("visible",0)
loJsonObj_1.UpdateBool("allow_join",1)
loJsonObj_1.UpdateBool("allow_for_external_meetings",1)
RELEASE loJsonObj_1
loReq.AddParam("internal_numbers",loJsonFormData1.Emit())
loReq.AddHeader("Authorization","Bearer <access_token>")
loResp = loHttp.SynchronousRequest("api.zoom.us",443,1,loReq)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loReq
RELEASE loJsonFormData1
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loReq
RELEASE loJsonFormData1
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnCount_i = loJResp.SizeOfArray("internal_numbers")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("internal_numbers[i].id")
lcV_number = loJResp.StringOf("internal_numbers[i].number")
lcDisplay_number = loJResp.StringOf("internal_numbers[i].display_number")
lcCountry = loJResp.StringOf("internal_numbers[i].country")
lnV_type = loJResp.IntOf("internal_numbers[i].type")
lcLabels = loJResp.StringOf("internal_numbers[i].labels")
lcLanguages = loJResp.StringOf("internal_numbers[i].languages")
lnVisible = loJResp.BoolOf("internal_numbers[i].visible")
lnAllow_join = loJResp.BoolOf("internal_numbers[i].allow_join")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loReq
RELEASE loJsonFormData1
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
