Swift3 / Zoom API / Assign SIP trunks
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let req = CkoHttpRequest()!
req.httpVerb = "POST"
req.path = "/v2/accounts/:accountId/sip_trunk/trunks"
req.contentType = "multipart/form-data"
let jsonFormData1 = CkoJsonArray()!
jsonFormData1.addObject(at: -1)
var jsonObj_1: CkoJsonObject? = jsonFormData1.object(at: jsonFormData1.size.intValue - 1)
jsonObj_1!.update("id", value: "amet in")
jsonObj_1!.update("dnis", value: "quis re")
jsonObj_1!.update("outbound_caller_id", value: "veniam")
jsonObj_1 = nil
req.addParam("sip_trunks", value: jsonFormData1.emit())
req.addHeader("Authorization", value: "Bearer <access_token>")
var resp: CkoHttpResponse? = http.synchronousRequest("api.zoom.us", port: 443, ssl: true, req: req)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var id: String?
var name: String?
var sip_server_address: String?
var dnis: String?
var number_prefix: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "sip_trunks").intValue
while i < count_i {
jResp.i = i
id = jResp.string(of: "sip_trunks[i].id")
name = jResp.string(of: "sip_trunks[i].name")
sip_server_address = jResp.string(of: "sip_trunks[i].sip_server_address")
dnis = jResp.string(of: "sip_trunks[i].dnis")
number_prefix = jResp.string(of: "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": ""
}
]
}
