Create SIP trunk

POST

sip-trunks

Create SIP trunk

curl --request POST \
  --url https://api.vatel.ai/v1/sip-trunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "caller_id_transforms": [
    {
      "value": "<string>",
      "value2": "<string>",
      "number": 123
    }
  ],
  "inbound_host": "<string>",
  "inbound_sip_username": "<string>",
  "inbound_sip_password": "<string>",
  "outbound_host": "<string>",
  "outbound_sip_username": "<string>",
  "outbound_sip_password": "<string>",
  "register": true,
  "remain_in_dialog": true
}
'

import requests

url = "https://api.vatel.ai/v1/sip-trunks"

payload = {
    "caller_id_transforms": [
        {
            "value": "<string>",
            "value2": "<string>",
            "number": 123
        }
    ],
    "inbound_host": "<string>",
    "inbound_sip_username": "<string>",
    "inbound_sip_password": "<string>",
    "outbound_host": "<string>",
    "outbound_sip_username": "<string>",
    "outbound_sip_password": "<string>",
    "register": True,
    "remain_in_dialog": True
}
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({
    caller_id_transforms: [{value: '<string>', value2: '<string>', number: 123}],
    inbound_host: '<string>',
    inbound_sip_username: '<string>',
    inbound_sip_password: '<string>',
    outbound_host: '<string>',
    outbound_sip_username: '<string>',
    outbound_sip_password: '<string>',
    register: true,
    remain_in_dialog: true
  })
};

fetch('https://api.vatel.ai/v1/sip-trunks', 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.vatel.ai/v1/sip-trunks",
  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([
    'caller_id_transforms' => [
        [
                'value' => '<string>',
                'value2' => '<string>',
                'number' => 123
        ]
    ],
    'inbound_host' => '<string>',
    'inbound_sip_username' => '<string>',
    'inbound_sip_password' => '<string>',
    'outbound_host' => '<string>',
    'outbound_sip_username' => '<string>',
    'outbound_sip_password' => '<string>',
    'register' => true,
    'remain_in_dialog' => true
  ]),
  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.vatel.ai/v1/sip-trunks"

	payload := strings.NewReader("{\n  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\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.vatel.ai/v1/sip-trunks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vatel.ai/v1/sip-trunks")

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  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "pbx": "3cx",
  "region": "us-central1",
  "caller_id_transforms": [
    {
      "type": "add_prefix",
      "value": "<string>",
      "value2": "<string>",
      "number": 123
    }
  ],
  "inbound_host": "<string>",
  "inbound_auth_type": "digest",
  "inbound_sip_username": "<string>",
  "inbound_registration_status": "not_registered",
  "outbound_host": "<string>",
  "outbound_sip_username": "<string>",
  "register": true,
  "outbound_registration_status": "not_registered",
  "remain_in_dialog": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Send your organization API key as Authorization: Bearer <key>.

Body

application/json

Create a SIP trunk; passwords are write-only on the wire.

pbx

enum<string>

required

PBX vendor preset or generic for other/custom PBX configurations.

Available options:

3cx,

yeastar,

webex,

generic

region

enum<string>

Vatel telephony region that should own this trunk's SIP edge. Set this to match the hostname you use when sending SIP to Vatel or pointing your PBX at Vatel: us-central1 for us-central1.sip.vatel.ai, northamerica-northeast1 for northamerica-northeast1.sip.vatel.ai. sip.vatel.ai is a convenience alias for US Central, not a third region. Defaults to us-central1 when omitted. Outbound SIP REGISTER originates from the selected region; inbound routing is not fully region-locked by this field yet.

Available options:

us-central1,

northamerica-northeast1

caller_id_transforms

object[]

Show child attributes

inbound_host

string | null

Inbound SIP host or domain; when inbound auth is acl, this host is ACL-validated for inbound traffic.

inbound_auth_type

enum<string> | null

How inbound SIP is authenticated. acl: carrier traffic must match the ACL; inbound_host is the ACL-validated host. digest: SIP digest authentication. none: no inbound auth configured.

Available options:

digest,

acl,

none

inbound_sip_username

string | null

inbound_sip_password

string | null

Inbound SIP secret if required.

outbound_host

string | null

Host to dial for outbound calls, on-call, and transfers.

outbound_sip_username

string | null

outbound_sip_password

string | null

Outbound SIP secret if required.

boolean | null

Enable outbound registration when true.

remain_in_dialog

boolean | null

Response

Created trunk

SIP connectivity profile for a supported PBX integration.

string<uuid>

created_at

string<date-time>

pbx

enum<string>

PBX vendor preset (3cx, yeastar, webex) applying default trunk behavior, or generic for other / custom PBX setups where you supply hosts and credentials explicitly.

Available options:

3cx,

yeastar,

webex,

generic

region

enum<string>

Available options:

us-central1,

northamerica-northeast1

caller_id_transforms

object[]

Ordered transforms applied to caller id.

Show child attributes

inbound_host

string

Inbound SIP host or domain. When inbound_auth_type is acl, this is the host validated against the ACL (allowed source for inbound calls).

inbound_auth_type

enum<string>

How inbound SIP is authenticated. acl: carrier traffic must match the ACL; inbound_host is the ACL-validated host. digest: SIP digest authentication. none: no inbound auth configured.

Available options:

digest,

acl,

none

inbound_sip_username

string

SIP user for inbound registration if used.

inbound_registration_status

enum<string>

Last known SIP registration outcome for the trunk leg.

Available options:

not_registered,

pending,

registered,

failed,

auth_failed

outbound_host

string

SIP host used for outbound legs: platform-initiated calls, on-call flows, and transfers dial out via this host (your carrier or SBC).

outbound_sip_username

string

Credentials username for outbound, if any.

boolean

Whether the platform registers this trunk with the carrier.

outbound_registration_status

enum<string>

Last known SIP registration outcome for the trunk leg.

Available options:

not_registered,

pending,

registered,

failed,

auth_failed

remain_in_dialog

boolean

Keeping SIP dialog routing behavior when true.

Create SIP trunk

curl --request POST \
  --url https://api.vatel.ai/v1/sip-trunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "caller_id_transforms": [
    {
      "value": "<string>",
      "value2": "<string>",
      "number": 123
    }
  ],
  "inbound_host": "<string>",
  "inbound_sip_username": "<string>",
  "inbound_sip_password": "<string>",
  "outbound_host": "<string>",
  "outbound_sip_username": "<string>",
  "outbound_sip_password": "<string>",
  "register": true,
  "remain_in_dialog": true
}
'

import requests

url = "https://api.vatel.ai/v1/sip-trunks"

payload = {
    "caller_id_transforms": [
        {
            "value": "<string>",
            "value2": "<string>",
            "number": 123
        }
    ],
    "inbound_host": "<string>",
    "inbound_sip_username": "<string>",
    "inbound_sip_password": "<string>",
    "outbound_host": "<string>",
    "outbound_sip_username": "<string>",
    "outbound_sip_password": "<string>",
    "register": True,
    "remain_in_dialog": True
}
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({
    caller_id_transforms: [{value: '<string>', value2: '<string>', number: 123}],
    inbound_host: '<string>',
    inbound_sip_username: '<string>',
    inbound_sip_password: '<string>',
    outbound_host: '<string>',
    outbound_sip_username: '<string>',
    outbound_sip_password: '<string>',
    register: true,
    remain_in_dialog: true
  })
};

fetch('https://api.vatel.ai/v1/sip-trunks', 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.vatel.ai/v1/sip-trunks",
  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([
    'caller_id_transforms' => [
        [
                'value' => '<string>',
                'value2' => '<string>',
                'number' => 123
        ]
    ],
    'inbound_host' => '<string>',
    'inbound_sip_username' => '<string>',
    'inbound_sip_password' => '<string>',
    'outbound_host' => '<string>',
    'outbound_sip_username' => '<string>',
    'outbound_sip_password' => '<string>',
    'register' => true,
    'remain_in_dialog' => true
  ]),
  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.vatel.ai/v1/sip-trunks"

	payload := strings.NewReader("{\n  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\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.vatel.ai/v1/sip-trunks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vatel.ai/v1/sip-trunks")

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  \"caller_id_transforms\": [\n    {\n      \"value\": \"<string>\",\n      \"value2\": \"<string>\",\n      \"number\": 123\n    }\n  ],\n  \"inbound_host\": \"<string>\",\n  \"inbound_sip_username\": \"<string>\",\n  \"inbound_sip_password\": \"<string>\",\n  \"outbound_host\": \"<string>\",\n  \"outbound_sip_username\": \"<string>\",\n  \"outbound_sip_password\": \"<string>\",\n  \"register\": true,\n  \"remain_in_dialog\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "pbx": "3cx",
  "region": "us-central1",
  "caller_id_transforms": [
    {
      "type": "add_prefix",
      "value": "<string>",
      "value2": "<string>",
      "number": 123
    }
  ],
  "inbound_host": "<string>",
  "inbound_auth_type": "digest",
  "inbound_sip_username": "<string>",
  "inbound_registration_status": "not_registered",
  "outbound_host": "<string>",
  "outbound_sip_username": "<string>",
  "register": true,
  "outbound_registration_status": "not_registered",
  "remain_in_dialog": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API documentation

Organization

Agents

Session

Calls

SIP trunks

LLMs

Voices

Twilio

SDK Guides

Examples

Authorizations

Body

Response