curl --request POST \
--url https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "Acme Carrier US",
"type": "smpp",
"remoteHost": "smpp.acme-carrier.example",
"remotePort": 2775,
"remoteSystemId": "orbit-mt",
"remotePassword": "s3cr3t",
"scope": "by_country_mcc",
"scopeFilter": {
"mccs": [
"310",
"311"
]
},
"priority": 50
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers"
payload = {
"label": "Acme Carrier US",
"type": "smpp",
"remoteHost": "smpp.acme-carrier.example",
"remotePort": 2775,
"remoteSystemId": "orbit-mt",
"remotePassword": "s3cr3t",
"scope": "by_country_mcc",
"scopeFilter": { "mccs": ["310", "311"] },
"priority": 50
}
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({
label: 'Acme Carrier US',
type: 'smpp',
remoteHost: 'smpp.acme-carrier.example',
remotePort: 2775,
remoteSystemId: 'orbit-mt',
remotePassword: 's3cr3t',
scope: 'by_country_mcc',
scopeFilter: {mccs: ['310', '311']},
priority: 50
})
};
fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', 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/messaging/smpp/carriers",
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([
'label' => 'Acme Carrier US',
'type' => 'smpp',
'remoteHost' => 'smpp.acme-carrier.example',
'remotePort' => 2775,
'remoteSystemId' => 'orbit-mt',
'remotePassword' => 's3cr3t',
'scope' => 'by_country_mcc',
'scopeFilter' => [
'mccs' => [
'310',
'311'
]
],
'priority' => 50
]),
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/messaging/smpp/carriers"
payload := strings.NewReader("{\n \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\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/messaging/smpp/carriers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers")
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 \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\n}"
response = http.request(request)
puts response.read_body{}{
"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>"
}
}Create SMPP or HTTP-API carrier
Register your own upstream termination carrier — an SMPP bind (type='smpp' with remoteHost, remotePort, remoteSystemId, remotePassword, optional bindType and TLS flags) or an HTTP API (type='http' with httpUrl, httpAuthType, httpCredentials) — that outbound MT traffic routes through while the row is active, at $0/message from Devotel. Routing fields pick what the carrier serves: scope='all' or scope='by_country_mcc' with a scopeFilter.mccs list (1–50 three-digit MCCs), plus a priority (lower wins). Submit status='inactive' to stage the row before flipping it live. The reconciler picks the row up on its next 30-second tick and opens the bind / installs the route. Owner / admin only, rate-limited to 20/hour per tenant; a missing connection block for the declared type is a 422.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "Acme Carrier US",
"type": "smpp",
"remoteHost": "smpp.acme-carrier.example",
"remotePort": 2775,
"remoteSystemId": "orbit-mt",
"remotePassword": "s3cr3t",
"scope": "by_country_mcc",
"scopeFilter": {
"mccs": [
"310",
"311"
]
},
"priority": 50
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers"
payload = {
"label": "Acme Carrier US",
"type": "smpp",
"remoteHost": "smpp.acme-carrier.example",
"remotePort": 2775,
"remoteSystemId": "orbit-mt",
"remotePassword": "s3cr3t",
"scope": "by_country_mcc",
"scopeFilter": { "mccs": ["310", "311"] },
"priority": 50
}
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({
label: 'Acme Carrier US',
type: 'smpp',
remoteHost: 'smpp.acme-carrier.example',
remotePort: 2775,
remoteSystemId: 'orbit-mt',
remotePassword: 's3cr3t',
scope: 'by_country_mcc',
scopeFilter: {mccs: ['310', '311']},
priority: 50
})
};
fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', 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/messaging/smpp/carriers",
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([
'label' => 'Acme Carrier US',
'type' => 'smpp',
'remoteHost' => 'smpp.acme-carrier.example',
'remotePort' => 2775,
'remoteSystemId' => 'orbit-mt',
'remotePassword' => 's3cr3t',
'scope' => 'by_country_mcc',
'scopeFilter' => [
'mccs' => [
'310',
'311'
]
],
'priority' => 50
]),
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/messaging/smpp/carriers"
payload := strings.NewReader("{\n \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\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/messaging/smpp/carriers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers")
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 \"label\": \"Acme Carrier US\",\n \"type\": \"smpp\",\n \"remoteHost\": \"smpp.acme-carrier.example\",\n \"remotePort\": 2775,\n \"remoteSystemId\": \"orbit-mt\",\n \"remotePassword\": \"s3cr3t\",\n \"scope\": \"by_country_mcc\",\n \"scopeFilter\": {\n \"mccs\": [\n \"310\",\n \"311\"\n ]\n },\n \"priority\": 50\n}"
response = http.request(request)
puts response.read_body{}{
"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
Human-readable name, 1–64 characters (required).
Carrier type: smpp (SMPP bind, default) or http (HTTP API).
SMPP: upstream host — hostname, IPv4 or IPv6 literal, no scheme or port (required for type='smpp').
SMPP: upstream port, 1–65535 (required for type='smpp').
SMPP: bind system_id, 1–15 characters per SMPP 3.4 (required for type='smpp').
SMPP: bind password, 1–8 characters (SMPP 3.4 C-Octet cap); encrypted at rest, never echoed back (required for type='smpp').
HTTP: upstream endpoint, HTTPS-only (required for type='http').
HTTP: auth scheme — basic, bearer or custom (required for type='http').
HTTP: opaque credential material the auth scheme consumes; encrypted at rest (required for type='http').
Routing scope: all (default) or by_country_mcc.
Routing filter { mccs: string[] } of 1–50 three-digit MCCs; required when scope='by_country_mcc'.
Route priority, 0–10000 (lower wins; default 100).
Initial lifecycle status — active, suspended or inactive; submit inactive to stage before going live.
Response
The created carrier — with the assigned id, credential material redacted to remotePasswordSet / httpCredentialsSet — wrapped in the standard { data, meta } envelope. Returns 422 when the body is invalid (a missing connection block for the declared type, or scope='by_country_mcc' without scopeFilter.mccs).
The created carrier — with the assigned id, credential material redacted to remotePasswordSet / httpCredentialsSet — wrapped in the standard { data, meta } envelope. Returns 422 when the body is invalid (a missing connection block for the declared type, or scope='by_country_mcc' without scopeFilter.mccs).