SMPP API

SMPP endpoints exposed by the Devotel CPaaS API Base path: /api/v1/messaging/smpp Endpoint count: 15

title: “Worked request and response samples” description: “Worked samples for the bring-your-own-carrier bind lifecycle: register a carrier (201), list the live bind rows, delete to take it out of rotation (204), and the 404 for an unknown carrier id.”

Worked request and response samples

Copy a request as written, substitute your own ids, and compare the response envelope. Errors follow Devotel Orbit’s { error, ... } envelope with the error.code your client branches on. The chain a carrier/SMPP integrator runs: register → list the live bind → delete to retire it.

1. Register a carrier bind

POST /api/v1/messaging/smpp/carriers

Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", headers=headers, json={
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", bytes.NewBuffer([]byte(`{
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "label": "euro-terminal-trunk",
  "type": "smpp",
  "remoteHost": "smpp.carrier-eu.example",
  "remotePort": 2775,
  "remoteSystemId": "orbit-mt",
  "remotePassword": "s3cr3t-bind",
  "bindType": "trx",
  "tlsEnabled": false,
  "scope": "all",
  "priority": 10,
  "status": "active"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "id_smppcr_7k2m9x4vbn",
    "label": "euro-terminal-trunk",
    "type": "smpp",
    "description": null,
    "remoteHost": "smpp.carrier-eu.example",
    "remotePort": 2775,
    "remoteSystemId": "orbit-mt",
    "remotePasswordSet": true,
    "bindType": "trx",
    "tlsEnabled": false,
    "tlsVerifyCert": false,
    "httpUrl": null,
    "httpAuthType": null,
    "httpCredentialsSet": false,
    "scope": "all",
    "scopeFilter": null,
    "priority": 10,
    "status": "active",
    "lastSeenAt": null,
    "bindStatus": null,
    "createdAt": "2026-08-24T09:41:12.000Z",
    "updatedAt": "2026-08-24T09:41:12.000Z"
  },
  "meta": {
    "requestId": "req_smpp_create",
    "timestamp": "2026-08-24T09:41:12.000Z"
  }
}

The created row registers a BYO upstream termination carrier your outbound messaging traffic routes through while status='active'. Devotel reads the routing fields (scope, priority — lower wins) and reconciles the SMPP bind within about 30 seconds; once live, GET on this row reports the reconciler-observed bindStatus (BOUND / UNBOUND / BIND_FAILED) and lastSeenAt. The password you sent is never on the wire again — reads redact it to remotePasswordSet: true. Most registrations on this platform connect to the inbound side (your SMSC binds to Orbit for MO and delivery receipts) — for that, create a credential (POST /api/v1/messaging/smpp/credentials) instead; a carrier is for outbound termination only.

2. List the live bind rows

GET /api/v1/messaging/smpp/carriers

Request

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

The list page returns data as an array of the full wire shape (see step 1 for every field). Rows come back in priority order, then newest-first within the same priority. There is no pagination envelope on this endpoint — the row set is a small per-tenant list. Filter status='active' client-side to find the routes currently eligible for outbound traffic.

3. Delete the carrier (204, hinted rebind)

DELETE /api/v1/messaging/smpp/carriers/{id}

Response: 204 No Content Delete is a soft delete — the row stays in your tenant for the audit chain with status='inactive', and routing stops sending through the carrier once the reconciler’s next ~30-second tick removes the underlying connector. Retired it by mistake? Re-activate with PATCH /api/v1/messaging/smpp/carriers/{id} and {"status": "active"} — a hinted rebind, no re-registration needed.

4. Unknown carrier id → 404

Reading, updating, testing, or deleting an id that is not a carrier in your tenant returns the 404 error envelope:

404

{
  "error": {
    "code": "NOT_FOUND",
    "status": 404,
    "message": "SMPP carrier not found."
  },
  "meta": {
    "requestId": "req_smpp_err",
    "timestamp": "2026-08-24T09:41:12.000Z"
  }
}

List SMPP carriers

GET /api/v1/messaging/smpp/carriers

List every BYO upstream termination carrier in the tenant, in priority order (lowest priority value first). A carrier is your own downstream SMSC — SMPP bind or HTTP API — that outbound MT traffic routes through when the row is active, and Devotel charges $0/message on those sends. Each item carries the full wire shape (id, label, type, connection block, scope, scopeFilter, priority, status, reconciler-observed bindStatus / lastSeenAt, timestamps) with credential material redacted to remotePasswordSet / httpCredentialsSet booleans. Use it to render a carrier table or confirm reconciliation state before a change.

string (enum: true|false)

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.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Get SMPP carrier

GET /api/v1/messaging/smpp/carriers/{id}

Fetch a single BYO upstream carrier by its id_smppcr_ id, returning the full configuration: label and carrier type (smpp or http), the connection block for that type (SMPP: remoteHost / remotePort / remoteSystemId / bindType / TLS flags; HTTP: httpUrl / httpAuthType), routing (scope, scopeFilter.mccs, priority), lifecycle status, and the reconciler-observed bindStatus / lastSeenAt. Credential material is redacted to remotePasswordSet / httpCredentialsSet booleans — never the value. Use it to hydrate a detail or edit view. Returns 404 when the id is not a carrier in this tenant.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Get SMPP carrier route scores

GET /api/v1/messaging/smpp/carriers/route-scores

Read the reconciler’s per-carrier route-policy breakdown — the live LCR scoring inputs (cost, delivery quality, bind health, sticky affinity) with their weights and per-carrier totals — that the preflight gate uses to pick the optimal egress route and to fail over on degradation. Read-only; the ranking refresh follows the reconciler’s tick, so scores here are eventually consistent with the preflight gate’s view. Use it to explain WHY a carrier won or lost routing before retuning priority or scope on the carrier itself.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-scores');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

List SMPP credentials

GET /api/v1/messaging/smpp/credentials

List every BYO-SMPP credential in the tenant, newest-first. A credential is the bind identity (systemId + password, generated at create) your SMSC uses to open an SMPP bind against Orbit for inbound (MO / delivery-receipt) traffic. The list view carries the full wire shape per credential (id, systemId, description, tpsLimit, allowedCidrs, dlrMode, dlrWebhookUrl, status, timestamps, bindCount, smppHost, smppPort, passwordRevealableUntil) — password material is never on the wire. Use it to hydrate a credentials table or to find a credential id before update / rotate / revoke.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Get SMPP credential

GET /api/v1/messaging/smpp/credentials/{id}

Fetch a single BYO-SMPP credential by its smppcred_ id, returning the full configuration: bind identity (systemId), description, throughput cap (tpsLimit), CIDR allow-list, DLR delivery mode and webhook URL, lifecycle status, timestamps, bind count, and the smppHost / smppPort pair your SMSC binds to. passwordRevealableUntil tells you whether GET /:id/reveal can still return the plaintext. Use it to hydrate a detail or edit view. Returns 404 when the id is not a credential in this tenant.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Reveal SMPP credential password

GET /api/v1/messaging/smpp/credentials/{id}/reveal

Return the plaintext bind password of an SMPP credential once, inside the short post-create (or post-rotate) reveal window — roughly 60 seconds from issuance. This is the ONLY read that ever returns password material, and it is gated to owner/admin only (developer / viewer roles are refused). After the window closes the secret is unrecoverable and the only recourse is POST /:id/rotate. Use it when the create / rotate response was not persisted. Returns 404 when the id is not a credential in this tenant and 410 when the reveal window has expired.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reveal');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Create SMPP or HTTP-API carrier

POST /api/v1/messaging/smpp/carriers

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.

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.

string (enum: true|false)

any

Human-readable name, 1–64 characters (required).

any

Carrier type: smpp (SMPP bind, default) or http (HTTP API).

any

SMPP: upstream host — hostname, IPv4 or IPv6 literal, no scheme or port (required for type='smpp').

any

SMPP: upstream port, 1–65535 (required for type='smpp').

any

SMPP: bind system_id, 1–15 characters per SMPP 3.4 (required for type='smpp').

any

SMPP: bind password, 1–8 characters (SMPP 3.4 C-Octet cap); encrypted at rest, never echoed back (required for type='smpp').

any

HTTP: upstream endpoint, HTTPS-only (required for type='http').

any

HTTP: auth scheme — basic, bearer or custom (required for type='http').

any

HTTP: opaque credential material the auth scheme consumes; encrypted at rest (required for type='http').

any

Routing scope: all (default) or by_country_mcc.

any

Routing filter { mccs: string[] } of 1–50 three-digit MCCs; required when scope='by_country_mcc'.

any

Route priority, 0–10000 (lower wins; default 100).

any

Initial lifecycle status — active, suspended or inactive; submit inactive to stage before going live.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "id_smppcr_7k2m9x4vbn",
    "label": "euro-terminal-trunk",
    "type": "smpp",
    "description": null,
    "remoteHost": "smpp.carrier-eu.example",
    "remotePort": 2775,
    "remoteSystemId": "orbit-mt",
    "remotePasswordSet": true,
    "bindType": "trx",
    "tlsEnabled": false,
    "tlsVerifyCert": false,
    "httpUrl": null,
    "httpAuthType": null,
    "httpCredentialsSet": false,
    "scope": "all",
    "scopeFilter": null,
    "priority": 10,
    "status": "active",
    "lastSeenAt": null,
    "bindStatus": null,
    "createdAt": "2026-08-24T09:41:12.000Z",
    "updatedAt": "2026-08-24T09:41:12.000Z"
  },
  "meta": {
    "requestId": "req_smpp_create",
    "timestamp": "2026-08-24T09:41:12.000Z"
  }
}

Test SMPP carrier bind

POST /api/v1/messaging/smpp/carriers/{id}/test

Run a synchronous test bind against a BYO upstream carrier and return the outcome: ok, the observed bindStatus (BOUND / UNBOUND / BIND_FAILED), a failure reason when it did not bind, and the bind round-trip time in durationMs. Run it right after creating or updating a carrier — and again when the dashboard flags a degraded route — before routing live traffic through it. Owner / admin only, rate-limited to 6/minute per tenant so a stuck upstream cannot be hammered; returns 404 when the id is not a carrier in this tenant.

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/test');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Dry-run LCR route quote

POST /api/v1/messaging/smpp/carriers/route-quote

Simulate the least-cost-routing decision for a destination and estimate the cost you would be charged. Everything is computed against the same scoring engine + scope-match the preflight gate uses: decision='byo' names the carrier that would win (cost $0 — you pay your upstream directly); decision='devotel' returns a Devotel-termination cost estimate off the pricing resolver (unitPriceCents/totalCents), or an explicit devotelQuote: null when pricing couldn’t resolve. The request body is { destination, messageCount } (messageCount defaults to 1). Nothing is billed — the endpoint is read-only and never debits your wallet.

string

string (enum: true|false)

string

required

The destination phone-number string (E.164 like +44... or the short-form you would actually send — the scope-match + price resolver interpret it exactly the way the live send does).

integer

How many messages to price (defaults to 1 so a single-send dry run reads a per-message unit price).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "destination": "+14155552671"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "destination": "+14155552671"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote", headers=headers, json={
  "destination": "+14155552671"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote", bytes.NewBuffer([]byte(`{
  "destination": "+14155552671"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "destination": "+14155552671"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/route-quote');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "destination": "+14155552671"
}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Create SMPP credential

POST /api/v1/messaging/smpp/credentials

Issue a new BYO-SMPP credential — the bind identity (systemId, smppcred_…) plus a generated password your SMSC uses to bind to Orbit for inbound (MO / delivery-receipt) traffic. All body fields are optional config: description, tpsLimit (1–1000, plan-tier-capped), allowedCidrs (up to 16 IPv4/IPv6 CIDRs that gate the bind source), dlrMode (bind delivers receipts on the SMPP bind, webhook POSTs them, both), and dlrWebhookUrl (HTTPS-only, SSRF-checked; required when dlrMode is webhook or both). THE PLAINTEXT PASSWORD IS RETURNED EXACTLY ONCE in this response together with the credential record — store it now. Within 60 seconds it remains re-fetchable via GET /:id/reveal; after that it is unrecoverable and you must call /rotate. Owner / admin only — an owner/admin dashboard session, or an API key scoped smpp:write — rate-limited to 10/hour per tenant.

string

string (enum: true|false)

any

Human-readable label, 1–200 characters (optional).

any

Inbound throughput cap, 1–1000 messages/second; additionally plan-tier-capped service-side (optional).

any

Up to 16 IPv4/IPv6 CIDR strings that gate which source IPs may bind (optional; empty means any).

any

Delivery-receipt delivery mode: bind, webhook or both (optional, defaults to bind).

any

HTTPS webhook endpoint for DLRs; required when dlrMode is webhook or both (optional otherwise).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "id_smppcr_7k2m9x4vbn",
    "label": "euro-terminal-trunk",
    "type": "smpp",
    "description": null,
    "remoteHost": "smpp.carrier-eu.example",
    "remotePort": 2775,
    "remoteSystemId": "orbit-mt",
    "remotePasswordSet": true,
    "bindType": "trx",
    "tlsEnabled": false,
    "tlsVerifyCert": false,
    "httpUrl": null,
    "httpAuthType": null,
    "httpCredentialsSet": false,
    "scope": "all",
    "scopeFilter": null,
    "priority": 10,
    "status": "active",
    "lastSeenAt": null,
    "bindStatus": null,
    "createdAt": "2026-08-24T09:41:12.000Z",
    "updatedAt": "2026-08-24T09:41:12.000Z"
  },
  "meta": {
    "requestId": "req_smpp_create",
    "timestamp": "2026-08-24T09:41:12.000Z"
  }
}

Rotate an SMPP credential’s password and return the new plaintext once

POST /api/v1/messaging/smpp/credentials/{id}/rotate

Issue a new SMPP bind password for an existing BYO-SMPP credential when the plaintext is lost (the 60-second reveal window expired), when the secret may be compromised, or on a scheduled rotation cycle. The credential’s systemId and every config field stay unchanged; only the password is replaced. The new plaintext is returned EXACTLY ONCE in this response — store it now. Owner / admin only — an owner/admin dashboard session, or an API key scoped smpp:write — rate-limited to 10 per hour per tenant. A 409 fires when the credential is revoked (create a new one instead), and 404 when no credential holds the id.

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rotate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Update SMPP carrier

PATCH /api/v1/messaging/smpp/carriers/{id}

Update mutable fields on a BYO upstream carrier in place — send only the fields you want to change (label, description, the type-specific connection block, routing scope / scopeFilter / priority, and/or status). Nullable fields (description, httpUrl, httpAuthType, scopeFilter) accept null to clear them; remotePassword rotation logs the field name but never the value. A status flip to active (back) reconciles the Jasmin connector on the next tick; inactive is the soft-deleted state. Use it to retune routing priority or rotate the upstream endpoint without dropping the row. Owner / admin only; returns 404 when the id is not a carrier in this tenant.

string

required

—

string (enum: true|false)

any

New human-readable name, 1–64 characters.

any

New SMPP upstream host (hostname / IPv4 / IPv6 literal).

any

New SMPP upstream port, 1–65535.

any

New SMPP system_id, 1–15 characters.

any

New SMPP bind password, 1–8 characters; encrypted at rest.

any

New routing scope: all or by_country_mcc.

any

New { mccs: string[] } filter (1–50 three-digit MCCs), or null to clear.

any

New route priority, 0–10000 (lower wins).

any

New lifecycle status — active, suspended or inactive.

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Update SMPP credential

PATCH /api/v1/messaging/smpp/credentials/{id}

Update mutable fields on an SMPP credential in place — send only the fields you want to change (description, tpsLimit, allowedCidrs, dlrMode, dlrWebhookUrl and/or status). Nullable fields (description, dlrWebhookUrl) accept null to clear them. A status flip is reconciler-routed: active enables the Jasmin user, suspended disables it, revoked removes it (soft delete). Use it to retune throughput, rotate the CIDR allow-list, move DLR delivery between bind and webhook, or suspend a credential without revoking it. Owner / admin only — an owner/admin dashboard session, or an API key scoped smpp:write; returns 404 when the id is not a credential in this tenant.

string

required

—

string (enum: true|false)

any

New human-readable label (1–200 chars), or null to clear.

any

New inbound throughput cap, 1–1000 messages/second.

any

Replacement CIDR allow-list (up to 16 IPv4/IPv6 CIDR strings).

any

New delivery-receipt mode: bind, webhook or both.

any

HTTPS webhook endpoint for DLRs, or null to clear; required when dlrMode is webhook or both.

any

New lifecycle status — active, suspended or revoked; reconciler-routed to Jasmin.

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "id_smppcr_7k2m9x4vbn",
      "label": "euro-terminal-trunk",
      "type": "smpp",
      "remoteHost": "smpp.carrier-eu.example",
      "remotePort": 2775,
      "remoteSystemId": "orbit-mt",
      "remotePasswordSet": true,
      "bindType": "trx",
      "tlsEnabled": false,
      "tlsVerifyCert": false,
      "scope": "all",
      "scopeFilter": null,
      "priority": 10,
      "status": "active",
      "lastSeenAt": "2026-08-24T09:41:42.000Z",
      "bindStatus": "BOUND",
      "createdAt": "2026-08-24T09:41:12.000Z",
      "updatedAt": "2026-08-24T09:41:12.000Z"
    }
  ],
  "meta": {
    "requestId": "req_smpp_list",
    "timestamp": "2026-08-24T09:41:54.000Z"
  }
}

Delete SMPP carrier

DELETE /api/v1/messaging/smpp/carriers/{id}

Soft-delete a BYO upstream carrier (sets status='inactive'). The row stays for the audit chain while the reconciler removes the Jasmin smppc connector and the mtrouter rule on its next ~30-second tick, which stops new sends routing through this carrier. Use it to take a carrier out of rotation; re-activate it via PATCH /:id with status='active' if you retired it by mistake. Owner / admin only; returns 404 when the id is not a carrier in this tenant and 204 No Content on success.

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/carriers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Response: 204 No Content

Revoke SMPP credential

DELETE /api/v1/messaging/smpp/credentials/{id}

Revoke an SMPP credential — a soft delete: the row stays for the audit chain while the reconciler removes the Jasmin user on its next tick, so the credential’s existing binds drop and new binds are rejected. Use it to retire a bind identity; revocation is provider-side and cannot be undone through this endpoint (create a new credential instead). Owner / admin only — an owner/admin dashboard session, or an API key scoped smpp:write; returns 404 when the id is not a credential in this tenant and 204 No Content on success.

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/messaging/smpp/credentials/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Response: 204 No Content

API Reference

All Endpoints

SMPP API

SMPP API

title: “Worked request and response samples” description: “Worked samples for the bring-your-own-carrier bind lifecycle: register a carrier (201), list the live bind rows, delete to take it out of rotation (204), and the 404 for an unknown carrier id.”

Worked request and response samples

1. Register a carrier bind

2. List the live bind rows

3. Delete the carrier (204, hinted rebind)

4. Unknown carrier id → 404

List SMPP carriers

Get SMPP carrier

Get SMPP carrier route scores

List SMPP credentials

Get SMPP credential

Reveal SMPP credential password

Create SMPP or HTTP-API carrier

Test SMPP carrier bind

Dry-run LCR route quote

Create SMPP credential

Rotate an SMPP credential’s password and return the new plaintext once

Update SMPP carrier

Update SMPP credential

Delete SMPP carrier

Revoke SMPP credential

​SMPP API

​title: “Worked request and response samples” description: “Worked samples for the bring-your-own-carrier bind lifecycle: register a carrier (201), list the live bind rows, delete to take it out of rotation (204), and the 404 for an unknown carrier id.”

​Worked request and response samples

​1. Register a carrier bind

​2. List the live bind rows

​3. Delete the carrier (204, hinted rebind)

​4. Unknown carrier id → 404

​List SMPP carriers

​Get SMPP carrier

​Get SMPP carrier route scores

​List SMPP credentials

​Get SMPP credential

​Reveal SMPP credential password

​Create SMPP or HTTP-API carrier

​Test SMPP carrier bind

​Dry-run LCR route quote

​Create SMPP credential

​Rotate an SMPP credential’s password and return the new plaintext once

​Update SMPP carrier

​Update SMPP credential

​Delete SMPP carrier

​Revoke SMPP credential

SMPP API

title: “Worked request and response samples” description: “Worked samples for the bring-your-own-carrier bind lifecycle: register a carrier (201), list the live bind rows, delete to take it out of rotation (204), and the 404 for an unknown carrier id.”

Worked request and response samples

1. Register a carrier bind

2. List the live bind rows

3. Delete the carrier (204, hinted rebind)

4. Unknown carrier id → 404

List SMPP carriers

Get SMPP carrier

Get SMPP carrier route scores

List SMPP credentials

Get SMPP credential

Reveal SMPP credential password

Create SMPP or HTTP-API carrier

Test SMPP carrier bind

Dry-run LCR route quote

Create SMPP credential

Rotate an SMPP credential’s password and return the new plaintext once

Update SMPP carrier

Update SMPP credential

Delete SMPP carrier

Revoke SMPP credential