SMS

Send SMS messages via Android phone gateways.

Requires an Android gateway device registered in the dashboard. SMS messages are sent through the physical phone and support batch sending with variable substitution.

Endpoints

Method	Description	Permission
GET	List SMS gateways	sms.history
POST	Send an SMS	sms.send
POST	Send SMS in batch	sms.send
GET	List SMS messages	sms.history
GET	Get SMS message details	sms.history

Send SMS

GET /api/v1/sms/gateways • POST /api/v1/sms/send

Request

Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "queued",
    "to": "+33612345678",
    "body": "Hello! Your order #1234 has been shipped.",
    "gatewayId": "gateway-uuid"
  }
}

json

Check SMS Status

GET /api/v1/sms/messages/:id

Request

Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "to": "+33612345678",
    "body": "Hello! Your order #1234 has been shipped.",
    "status": "delivered",
    "gatewayId": "gateway-uuid",
    "created_at": "2026-03-18T10:00:00Z",
    "sent_at": "2026-03-18T10:00:03Z",
    "delivered_at": "2026-03-18T10:00:05Z"
  }
}

json