curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "agent",
"config": {
"agentId": "agent_01J9ZAGENT"
},
"fallback_type": "voicemail",
"fallback_config": {},
"active": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing"
payload = {
"type": "agent",
"config": { "agentId": "agent_01J9ZAGENT" },
"fallback_type": "voicemail",
"fallback_config": {},
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'agent',
config: {agentId: 'agent_01J9ZAGENT'},
fallback_type: 'voicemail',
fallback_config: {},
active: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing', 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/numbers/{phoneNumber}/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'agent',
'config' => [
'agentId' => 'agent_01J9ZAGENT'
],
'fallback_type' => 'voicemail',
'fallback_config' => [
],
'active' => 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.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing"
payload := strings.NewReader("{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "route_01J9Z8ABCDEF",
"phone_number": "+14155550100",
"type": "agent",
"config": {
"agentId": "agent_01J9ZAGENT"
},
"fallback_type": "voicemail",
"fallback_config": {},
"active": true
},
"meta": {
"request_id": "req_01J9Z8ABCDEF",
"timestamp": "2026-08-11T12:00:00.000Z"
}
}{
"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>"
}
}Set a number's inbound call/SMS route
Create or replace (upsert) the inbound routing configuration for one owned DID. Choose how inbound calls are answered via type + config — route to an AI agent, a voicemail box, an ivr, a sip_forward endpoint, a ring_group, and more — with an optional fallback_type, business-hours gating, caller-ID allow/block filtering, a per-route recording override, and an optional per-DID inbound-SMS route. The route shape and any config URLs are safety-validated before persisting. This configures INBOUND handling only; it does not affect outbound calling. Returns the saved route with SIP passwords redacted. Scoped on the numbers resource (numbers:read or numbers:write).
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "agent",
"config": {
"agentId": "agent_01J9ZAGENT"
},
"fallback_type": "voicemail",
"fallback_config": {},
"active": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing"
payload = {
"type": "agent",
"config": { "agentId": "agent_01J9ZAGENT" },
"fallback_type": "voicemail",
"fallback_config": {},
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'agent',
config: {agentId: 'agent_01J9ZAGENT'},
fallback_type: 'voicemail',
fallback_config: {},
active: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing', 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/numbers/{phoneNumber}/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'agent',
'config' => [
'agentId' => 'agent_01J9ZAGENT'
],
'fallback_type' => 'voicemail',
'fallback_config' => [
],
'active' => 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.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing"
payload := strings.NewReader("{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/numbers/{phoneNumber}/routing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"agent\",\n \"config\": {\n \"agentId\": \"agent_01J9ZAGENT\"\n },\n \"fallback_type\": \"voicemail\",\n \"fallback_config\": {},\n \"active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "route_01J9Z8ABCDEF",
"phone_number": "+14155550100",
"type": "agent",
"config": {
"agentId": "agent_01J9ZAGENT"
},
"fallback_type": "voicemail",
"fallback_config": {},
"active": true
},
"meta": {
"request_id": "req_01J9Z8ABCDEF",
"timestamp": "2026-08-11T12:00:00.000Z"
}
}{
"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
Dashboard JWT token from Clerk
Headers
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.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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.
true, false Path Parameters
The DID in E.164 (e.g. +14155550100). A leading + is optional — it is added if missing.
Body
The inbound route to persist. type + config are required and validated together by the handler.
The inbound route to persist. type + config are required and validated together by the handler.
Primary route type — one of agent, softphone_user, softphone_register, ivr, voicemail, queue, sip_forward, transfer, conference, decline, ring_group, shared_line, dispatch_to_voicemail_box, or a webhook (voiceUrl) route.
Type-specific configuration (e.g. { agentId } for agent, { sipUri, sipUsername, sipPassword } for sip_forward).
Optional fallback route type used when the primary route fails.
Config for the fallback route.
Whether the route is active (default true).
Per-route recording override — off | all | inbound | outbound, or null to inherit the org default.
Required when type is ring_group — an existing ring-group id owned by this organization.
Optional per-DID inbound-SMS route — webhook | agent | auto_reply | disabled.