curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/voice/call-forwarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destinations": [],
"ring_timeout_sec": 20,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/call-forwarding"
payload = {
"destinations": [],
"ring_timeout_sec": 20,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": False
}
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({
destinations: [],
ring_timeout_sec: 20,
active_from: '2023-11-07T05:31:56Z',
active_until: '2023-11-07T05:31:56Z',
note: '<string>',
reject_anonymous: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/call-forwarding', 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/call-forwarding",
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([
'destinations' => [
],
'ring_timeout_sec' => 20,
'active_from' => '2023-11-07T05:31:56Z',
'active_until' => '2023-11-07T05:31:56Z',
'note' => '<string>',
'reject_anonymous' => false
]),
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/call-forwarding"
payload := strings.NewReader("{\n \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\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/voice/call-forwarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/call-forwarding")
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 \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"mode": "none",
"destinations": [
{
"kind": "pstn",
"value": "<string>",
"label": "<string>"
}
],
"ring_timeout_sec": 62,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}Upsert my call-forwarding rule
Creates or replaces the authenticated user’s own call-forwarding rule. Idempotent upsert keyed on the user. PSTN destinations must be E.164 and SIP destinations must be sip:-prefixed, else 400. Returns the resolved rule.
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/voice/call-forwarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"destinations": [],
"ring_timeout_sec": 20,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": false
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/call-forwarding"
payload = {
"destinations": [],
"ring_timeout_sec": 20,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": False
}
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({
destinations: [],
ring_timeout_sec: 20,
active_from: '2023-11-07T05:31:56Z',
active_until: '2023-11-07T05:31:56Z',
note: '<string>',
reject_anonymous: false
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/call-forwarding', 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/call-forwarding",
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([
'destinations' => [
],
'ring_timeout_sec' => 20,
'active_from' => '2023-11-07T05:31:56Z',
'active_until' => '2023-11-07T05:31:56Z',
'note' => '<string>',
'reject_anonymous' => false
]),
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/call-forwarding"
payload := strings.NewReader("{\n \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\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/voice/call-forwarding")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/call-forwarding")
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 \"destinations\": [],\n \"ring_timeout_sec\": 20,\n \"active_from\": \"2023-11-07T05:31:56Z\",\n \"active_until\": \"2023-11-07T05:31:56Z\",\n \"note\": \"<string>\",\n \"reject_anonymous\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"mode": "none",
"destinations": [
{
"kind": "pstn",
"value": "<string>",
"label": "<string>"
}
],
"ring_timeout_sec": 62,
"active_from": "2023-11-07T05:31:56Z",
"active_until": "2023-11-07T05:31:56Z",
"note": "<string>",
"reject_anonymous": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"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 Body
Call-handling mode to apply.
none, forward_all, sim_ring, sequential, forward_after_timeout Ordered forwarding targets (max 5). Defaults to empty.
5Show child attributes
Show child attributes
Seconds to ring before the rule falls through. Defaults to 20.
5 <= x <= 120ISO-8601 timestamp the rule starts applying (null/omitted = always-on).
ISO-8601 timestamp the rule stops applying (null/omitted = always-on).
Optional free-text note (max 280 chars).
280Decline inbound legs with a withheld/anonymous caller-id before any fan-out. Defaults to false.