Send a message

Send a message

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/messages/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "body": "<string>",
  "channel": "<string>",
  "template_name": "<string>",
  "language": "<string>",
  "variables": {},
  "media_url": "<string>",
  "from": "<string>",
  "webhook_url": "<string>",
  "scheduled_at": "<string>",
  "metadata": {},
  "country": "<string>"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/messages/send"

payload = {
    "to": "<string>",
    "body": "<string>",
    "channel": "<string>",
    "template_name": "<string>",
    "language": "<string>",
    "variables": {},
    "media_url": "<string>",
    "from": "<string>",
    "webhook_url": "<string>",
    "scheduled_at": "<string>",
    "metadata": {},
    "country": "<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({
    to: '<string>',
    body: JSON.stringify('<string>'),
    channel: '<string>',
    template_name: '<string>',
    language: '<string>',
    variables: {},
    media_url: '<string>',
    from: '<string>',
    webhook_url: '<string>',
    scheduled_at: '<string>',
    metadata: {},
    country: '<string>'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/messages/send', 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/messages/send",
  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([
    'to' => '<string>',
    'body' => '<string>',
    'channel' => '<string>',
    'template_name' => '<string>',
    'language' => '<string>',
    'variables' => [
        
    ],
    'media_url' => '<string>',
    'from' => '<string>',
    'webhook_url' => '<string>',
    'scheduled_at' => '<string>',
    'metadata' => [
        
    ],
    'country' => '<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/messages/send"

	payload := strings.NewReader("{\n  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<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/messages/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/messages/send")

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  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "channel": "<string>",
    "to": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "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>"
  }
}

POST

api

messages

send

Send a message

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/messages/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "body": "<string>",
  "channel": "<string>",
  "template_name": "<string>",
  "language": "<string>",
  "variables": {},
  "media_url": "<string>",
  "from": "<string>",
  "webhook_url": "<string>",
  "scheduled_at": "<string>",
  "metadata": {},
  "country": "<string>"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/messages/send"

payload = {
    "to": "<string>",
    "body": "<string>",
    "channel": "<string>",
    "template_name": "<string>",
    "language": "<string>",
    "variables": {},
    "media_url": "<string>",
    "from": "<string>",
    "webhook_url": "<string>",
    "scheduled_at": "<string>",
    "metadata": {},
    "country": "<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({
    to: '<string>',
    body: JSON.stringify('<string>'),
    channel: '<string>',
    template_name: '<string>',
    language: '<string>',
    variables: {},
    media_url: '<string>',
    from: '<string>',
    webhook_url: '<string>',
    scheduled_at: '<string>',
    metadata: {},
    country: '<string>'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/messages/send', 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/messages/send",
  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([
    'to' => '<string>',
    'body' => '<string>',
    'channel' => '<string>',
    'template_name' => '<string>',
    'language' => '<string>',
    'variables' => [
        
    ],
    'media_url' => '<string>',
    'from' => '<string>',
    'webhook_url' => '<string>',
    'scheduled_at' => '<string>',
    'metadata' => [
        
    ],
    'country' => '<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/messages/send"

	payload := strings.NewReader("{\n  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<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/messages/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/messages/send")

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  \"to\": \"<string>\",\n  \"body\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"template_name\": \"<string>\",\n  \"language\": \"<string>\",\n  \"variables\": {},\n  \"media_url\": \"<string>\",\n  \"from\": \"<string>\",\n  \"webhook_url\": \"<string>\",\n  \"scheduled_at\": \"<string>\",\n  \"metadata\": {},\n  \"country\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "channel": "<string>",
    "to": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "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

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

string

required

Recipient identifier (E.164 phone or email)

body

string

Message body text (required unless template_name or media_url is set). An empty string is treated the same as an omitted value.

channel

string

Delivery channel — defaults to auto-routing when omitted

Maximum string length: 32

template_name

string

Approved template to send instead of a freeform body (e.g. WhatsApp template name).

language

string

BCP-47 language code for the template (e.g. en_US).

variables

object

Template substitution variables (Twilio-parity scalar map).

media_url

string

HTTPS URL of a media attachment (MMS / WhatsApp single-attachment). At least one of body, template_name, or media_url is required. An empty string is treated the same as an omitted value.

Maximum string length: 2048

from

string

Sender identity: E.164 phone number, alphanumeric sender ID (1-11 characters), short code, or the platform sentinel __shared_generic__. Normalized and validated server-side. Defaults to the account sender when omitted.

Maximum string length: 64

webhook_url

string

Per-send DLR callback URL (HTTPS, Twilio StatusCallback parity). Optional — an empty string is treated as 'no webhook'. Non-empty values must be https:// and pass the SSRF guard.

Maximum string length: 2048

scheduled_at

string

ISO 8601 datetime for scheduled delivery. Accepts a full ISO 8601 string (e.g. 2027-01-01T12:00:00Z) or a datetime-local value (e.g. 2027-01-01T12:00). Validated server-side; the message is persisted as scheduled until the target time.

metadata

object

Arbitrary key-value metadata (Twilio-parity scalar values), echoed back on delivery-status webhooks and message lookups.

country

string

ISO 3166-1 alpha-2 country hint (e.g. US). Disambiguates national-format recipient numbers and gates short-code validation.

Maximum string length: 2

Response

Message accepted for delivery

data

object

Show child attributes

API Reference

All Endpoints

Authorizations

Headers

Body

Response