SMS API Reference

API reference for the SMS module.

Send SMS

Send Message

POST /sms/send
masterkey: {masterKey}

Request Body:

{
  "to": "+1234567890",
  "message": "Your verification code is 123456"
}

Response:

{
  "message": "SMS sent successfully",
  "messageId": "..."
}

Send to Multiple Recipients

POST /sms/sendMany
masterkey: {masterKey}

Request Body:

{
  "to": ["+1234567890", "+0987654321"],
  "message": "Broadcast message"
}

Configuration

Get Config

GET /admin/sms/config
masterkey: {masterKey}

Update Config

PUT /admin/sms/config
masterkey: {masterKey}

Request Body:

{
  "provider": "twilio",
  "twilio": {
    "accountSid": "...",
    "authToken": "...",
    "phoneNumber": "+1..."
  }
}

Error Handling

Status	Description
400	Invalid phone number format
401	Invalid credentials
500	Provider error