Recommend a messaging channel from a send intent
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messageType": "marketing",
"urgency": "high",
"costOptimize": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations"
payload = {
"messageType": "marketing",
"urgency": "high",
"costOptimize": 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({messageType: 'marketing', urgency: 'high', costOptimize: true})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations', 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/contacts/{id}/channel-recommendations",
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([
'messageType' => 'marketing',
'urgency' => 'high',
'costOptimize' => 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/contacts/{id}/channel-recommendations"
payload := strings.NewReader("{\n \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": 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/contacts/{id}/channel-recommendations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations")
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 \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contact_id": "contact_01HZX8Y7QJK4M",
"channel": "sms",
"reason": "Fast channel preferred for a high-urgency marketing send.",
"fallbackChain": [
"whatsapp",
"email"
],
"estimatedCostCents": 0.7,
"engagementScore": 0.52,
"historical_engagement": {
"sms": 0.52,
"whatsapp": 0.49
}
},
"meta": {
"request_id": "req_01HZX9MNOPQR",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Contacts
Recommend a messaging channel from a send intent
Score a contact’s reachable messaging channels for a specific send intent supplied in the request body, so a caller can evaluate a message without encoding it in the query string. Provide any of messageType, urgency and costOptimize; each is optional and defaults to a transactional, medium-urgency, cost-neutral intent. Returns the ranked primary channel, fallback chain, predicted engagement score, estimated per-message cost and the reason.
POST
/
api
/
v1
/
contacts
/
{id}
/
channel-recommendations
Recommend a messaging channel from a send intent
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messageType": "marketing",
"urgency": "high",
"costOptimize": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations"
payload = {
"messageType": "marketing",
"urgency": "high",
"costOptimize": 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({messageType: 'marketing', urgency: 'high', costOptimize: true})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations', 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/contacts/{id}/channel-recommendations",
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([
'messageType' => 'marketing',
'urgency' => 'high',
'costOptimize' => 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/contacts/{id}/channel-recommendations"
payload := strings.NewReader("{\n \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": 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/contacts/{id}/channel-recommendations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/{id}/channel-recommendations")
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 \"messageType\": \"marketing\",\n \"urgency\": \"high\",\n \"costOptimize\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contact_id": "contact_01HZX8Y7QJK4M",
"channel": "sms",
"reason": "Fast channel preferred for a high-urgency marketing send.",
"fallbackChain": [
"whatsapp",
"email"
],
"estimatedCostCents": 0.7,
"engagementScore": 0.52,
"historical_engagement": {
"sms": 0.52,
"whatsapp": 0.49
}
},
"meta": {
"request_id": "req_01HZX9MNOPQR",
"timestamp": "2026-02-02T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Body
application/json
Kind of message being sent. Defaults to transactional.
Available options:
transactional, marketing, otp Delivery urgency. Defaults to medium.
Available options:
low, medium, high When true, prefer the cheapest channel that meets the quality bar.
⌘I