Create an outbound SIP trunk

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/voice/sip-trunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "host": "<string>",
  "port": 32768,
  "authentication": {
    "username": "<string>",
    "password": "<string>"
  },
  "codecs": [
    "<string>"
  ],
  "enabled": true,
  "maxConcurrent": 1000.5,
  "failoverTrunkId": "<string>",
  "probe_error": "<string>"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/voice/sip-trunks"

payload = {
    "name": "<string>",
    "host": "<string>",
    "port": 32768,
    "authentication": {
        "username": "<string>",
        "password": "<string>"
    },
    "codecs": ["<string>"],
    "enabled": True,
    "maxConcurrent": 1000.5,
    "failoverTrunkId": "<string>",
    "probe_error": "<string>"
}
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({
    name: '<string>',
    host: '<string>',
    port: 32768,
    authentication: {username: '<string>', password: '<string>'},
    codecs: ['<string>'],
    enabled: true,
    maxConcurrent: 1000.5,
    failoverTrunkId: '<string>',
    probe_error: '<string>'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/voice/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.orbit.devotel.io/api/v1/voice/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([
    'name' => '<string>',
    'host' => '<string>',
    'port' => 32768,
    'authentication' => [
        'username' => '<string>',
        'password' => '<string>'
    ],
    'codecs' => [
        '<string>'
    ],
    'enabled' => true,
    'maxConcurrent' => 1000.5,
    'failoverTrunkId' => '<string>',
    'probe_error' => '<string>'
  ]),
  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.orbit.devotel.io/api/v1/voice/sip-trunks"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\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.orbit.devotel.io/api/v1/voice/sip-trunks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/voice/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  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\n}"

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

{}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Voice

Create an outbound SIP trunk

Provision a BYO-carrier SIP trunk for outbound PSTN. The trunk is validated pre-save: set probe_status to registered / unregistered / unknown from a prior POST /sip-trunks/probe (smoke test the registrar before saving), and on a failed probe pass the diagnostic reason in probe_error. The wire remembers probe_status against the trunk so its live status does not start as “Unregistered” while the probe is fresh (5-minute freshness window). Optional failoverTrunkId points at a fallback trunk consulted when the primary is unregistered. Requires owner/admin.

POST

api

voice

sip-trunks

Create an outbound SIP trunk

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/voice/sip-trunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "host": "<string>",
  "port": 32768,
  "authentication": {
    "username": "<string>",
    "password": "<string>"
  },
  "codecs": [
    "<string>"
  ],
  "enabled": true,
  "maxConcurrent": 1000.5,
  "failoverTrunkId": "<string>",
  "probe_error": "<string>"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/voice/sip-trunks"

payload = {
    "name": "<string>",
    "host": "<string>",
    "port": 32768,
    "authentication": {
        "username": "<string>",
        "password": "<string>"
    },
    "codecs": ["<string>"],
    "enabled": True,
    "maxConcurrent": 1000.5,
    "failoverTrunkId": "<string>",
    "probe_error": "<string>"
}
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({
    name: '<string>',
    host: '<string>',
    port: 32768,
    authentication: {username: '<string>', password: '<string>'},
    codecs: ['<string>'],
    enabled: true,
    maxConcurrent: 1000.5,
    failoverTrunkId: '<string>',
    probe_error: '<string>'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/voice/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.orbit.devotel.io/api/v1/voice/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([
    'name' => '<string>',
    'host' => '<string>',
    'port' => 32768,
    'authentication' => [
        'username' => '<string>',
        'password' => '<string>'
    ],
    'codecs' => [
        '<string>'
    ],
    'enabled' => true,
    'maxConcurrent' => 1000.5,
    'failoverTrunkId' => '<string>',
    'probe_error' => '<string>'
  ]),
  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.orbit.devotel.io/api/v1/voice/sip-trunks"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\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.orbit.devotel.io/api/v1/voice/sip-trunks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/voice/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  \"name\": \"<string>\",\n  \"host\": \"<string>\",\n  \"port\": 32768,\n  \"authentication\": {\n    \"username\": \"<string>\",\n    \"password\": \"<string>\"\n  },\n  \"codecs\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"maxConcurrent\": 1000.5,\n  \"failoverTrunkId\": \"<string>\",\n  \"probe_error\": \"<string>\"\n}"

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

{}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Dashboard JWT token from Clerk

Headers

Idempotency-Key

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255

X-Test-Mode

enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:

true,

false

Body

application/json

name

string

Display name.

Required string length: 1 - 120

host

string

Registrar hostname or IP of the carrier SBC.

Required string length: 1 - 253

port

number

SIP port (default 5060).

Required range: 1 <= x <= 65535

transport

enum<string>

SIP transport (default udp).

Available options:

udp,

tcp,

tls

authentication

object

Optional REGISTER credentials for outbound gateways that expect digest auth.

Show child attributes

codecs

string[]

Optional ordered codec preference list.

Maximum array length: 20

Maximum string length: 32

enabled

boolean

Whether the trunk participates in outbound dispatch (default true).

maxConcurrent

number

Optional concurrent-call cap respected at dispatch.

Required range: 1 <= x <= 2000

failoverTrunkId

string

Optional fallback trunk id consulted when the primary reports unregistered.

probe_status

enum<string>

Result of a prior POST /sip-trunks/probe the front-end ran. Only registered stamps the freshness window; unregistered pairs with probe_error for the diagnostic.

Available options:

registered,

unregistered,

unknown

probe_error

string

Diagnostic reason from a failed pre-save probe (probe_status = unregistered). Rendered verbatim on the trunk row.

Maximum string length: 500

Response

Created — the resource was created successfully.

The response is of type object.

API Reference

All Endpoints

Create an outbound SIP trunk

Authorizations

Headers

Body

Response