Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
BYO-SMPP Credentials API
Bring-your-own SMPP for organizations with existing carrier relationships. You provide SMPP host, port, system_id, and password; Orbit’s SMPP control plane (Jasmin) auto-reconciles your credentials into its user store every 30 seconds and routes outbound SMS through your trunk.
Base path: /v1/messaging
Authentication: API key (X-API-Key) or session JWT.
Credentials
| Method | Path | Purpose |
|---|
GET | /v1/messaging/smpp/credentials | List credentials |
POST | /v1/messaging/smpp/credentials | Add a credential set |
GET | /v1/messaging/smpp/credentials/{id} | Get a credential |
PATCH | /v1/messaging/smpp/credentials/{id} | Update host / port / system_type |
DELETE | /v1/messaging/smpp/credentials/{id} | Remove |
GET | /v1/messaging/smpp/credentials/{id}/reveal | One-time reveal of the password (audit-logged) |
POST | /v1/messaging/smpp/credentials/{id}/rotate | Rotate password |
Carriers
A carrier definition pairs a credential set with routing metadata — supported countries, quality, fallback order, billing rate.
| Method | Path | Purpose |
|---|
GET | /v1/messaging/smpp/carriers | List configured carriers |
POST | /v1/messaging/smpp/carriers | Add a carrier |
GET | /v1/messaging/smpp/carriers/{id} | Get a carrier |
PATCH | /v1/messaging/smpp/carriers/{id} | Update routing metadata |
DELETE | /v1/messaging/smpp/carriers/{id} | Remove |
POST | /v1/messaging/smpp/carriers/{id}/test | Send a test message through this carrier |
Sender pools
Group multiple sender IDs / numbers into a pool that the router rotates across. Pools attach to carriers and are referenced by campaigns.
| Method | Path | Purpose |
|---|
GET | /v1/messaging/sender-pools | List sender pools |
POST | /v1/messaging/sender-pools | Create a pool |
GET | /v1/messaging/sender-pools/{id} | Get a pool |
PATCH | /v1/messaging/sender-pools/{id} | Update pool members |
DELETE | /v1/messaging/sender-pools/{id} | Delete |
GET | /v1/messaging/sender-pools/{id}/preview | Preview which sender will be picked for a destination |
See also
