SMS
Endpoints for sending SMS, checking status, and templates
SMS API
Base path: /v1/sms
Send SMS
- POST
/v1/sms/send
Request body (JSON):
{
"from": "+15551234567",
"to": ["+15557654321"],
"body": "Your code is 123456",
"template_id": null,
"template_data": {}
}Response (201):
{
"id": "sms_456",
"status": "queued",
"accepted": ["+15557654321"]
}Get Message Status
- GET
/v1/sms/{id}
Response:
{
"id": "sms_456",
"status": "delivered",
"delivered_at": "2025-11-01T12:34:56Z",
"recipients": [
{ "phone": "+15557654321", "status": "delivered" }
]
}Templates
SMS templates allow personalization and support simple placeholders.