SIP trunks
Add gateway to SIP trunk API
Add a carrier SIP host that outbound calls are sent to via POST /trunk/trunks//gateways; gateways are tried in priority order.
POST
/
trunk
/
trunks
/
{trunk_id}
/
gateways
cURL
curl --request POST \
--url https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "sip.example.com",
"port": 5060,
"priority": 1
}
'import requests
url = "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways"
payload = {
"host": "sip.example.com",
"port": 5060,
"priority": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({host: 'sip.example.com', port: 5060, priority: 1})
};
fetch('https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'host' => 'sip.example.com',
'port' => 5060,
'priority' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways"
payload := strings.NewReader("{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"host": "sip.example.com",
"resolved_ips": [
"203.0.113.30"
],
"port": 5060,
"priority": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"deleted_at": "2023-11-07T05:31:56Z"
}{
"message": "a trunk has at most 8 gateways"
}{
"message": "<string>"
}{
"detail": {
"code": "number_taken",
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The trunk's id
Body
application/json
The carrier's SIP host, as an IPv4 address or a DNS name. A literal address must be public.
Example:
"sip.example.com"
The carrier's SIP port.
Required range:
1 <= x <= 65535Order in which gateways are tried; lowest first.
Required range:
0 <= x <= 100Response
The added gateway
Example:
"sip.example.com"
The public IPv4 addresses host resolved to when it was saved.
Example:
["203.0.113.30"]
Example:
5060
Example:
1
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"host": "sip.example.com",
"port": 5060,
"priority": 1
}
'import requests
url = "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways"
payload = {
"host": "sip.example.com",
"port": 5060,
"priority": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({host: 'sip.example.com', port: 5060, priority: 1})
};
fetch('https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'host' => 'sip.example.com',
'port' => 5060,
'priority' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways"
payload := strings.NewReader("{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolna.ai/trunk/trunks/{trunk_id}/gateways")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"host\": \"sip.example.com\",\n \"port\": 5060,\n \"priority\": 1\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"host": "sip.example.com",
"resolved_ips": [
"203.0.113.30"
],
"port": 5060,
"priority": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_deleted": true,
"deleted_at": "2023-11-07T05:31:56Z"
}{
"message": "a trunk has at most 8 gateways"
}{
"message": "<string>"
}{
"detail": {
"code": "number_taken",
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
