Preview a find-me/follow-me ring plan
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"value": "<string>",
"ring_seconds": 20,
"label": "<string>"
}
],
"fallback_to_voicemail": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan"
payload = {
"steps": [
{
"value": "<string>",
"ring_seconds": 20,
"label": "<string>"
}
],
"fallback_to_voicemail": 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({
steps: [{value: '<string>', ring_seconds: 20, label: '<string>'}],
fallback_to_voicemail: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan', 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/find-me-follow-me/plan",
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([
'steps' => [
[
'value' => '<string>',
'ring_seconds' => 20,
'label' => '<string>'
]
],
'fallback_to_voicemail' => 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/voice/find-me-follow-me/plan"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": 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.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan")
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 \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"legs": [
{
"order": 123,
"value": "<string>",
"start_offset_sec": 123,
"ring_seconds": 123,
"end_offset_sec": 123,
"label": "<string>"
}
],
"total_ring_seconds": 123,
"fallback": {
"to_voicemail": true,
"at_offset_sec": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Voice
Preview a find-me/follow-me ring plan
Validates a posted ring ladder and returns the resolved plan — ordered dial legs with cumulative start/end offsets plus the terminal voicemail fallback. Stateless preview (persists nothing); used by the voice-preferences UI to render the ring schedule before save.
POST
/
api
/
v1
/
voice
/
find-me-follow-me
/
plan
Preview a find-me/follow-me ring plan
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"value": "<string>",
"ring_seconds": 20,
"label": "<string>"
}
],
"fallback_to_voicemail": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan"
payload = {
"steps": [
{
"value": "<string>",
"ring_seconds": 20,
"label": "<string>"
}
],
"fallback_to_voicemail": 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({
steps: [{value: '<string>', ring_seconds: 20, label: '<string>'}],
fallback_to_voicemail: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan', 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/find-me-follow-me/plan",
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([
'steps' => [
[
'value' => '<string>',
'ring_seconds' => 20,
'label' => '<string>'
]
],
'fallback_to_voicemail' => 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/voice/find-me-follow-me/plan"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": 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.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/find-me-follow-me/plan")
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 \"steps\": [\n {\n \"value\": \"<string>\",\n \"ring_seconds\": 20,\n \"label\": \"<string>\"\n }\n ],\n \"fallback_to_voicemail\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"legs": [
{
"order": 123,
"value": "<string>",
"start_offset_sec": 123,
"ring_seconds": 123,
"end_offset_sec": 123,
"label": "<string>"
}
],
"total_ring_seconds": 123,
"fallback": {
"to_voicemail": true,
"at_offset_sec": 123
}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Ordered ring ladder — the array index IS the ring order (index 0 rings first).
Required array length:
1 - 5 elementsShow child attributes
Show child attributes
When true (default), the sequence ends at the user's voicemail box after the final step. When false, the leg falls to the route-level default (e.g. org auto-attendant).
⌘I