Quick Start

POST /v1/sms/messages
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "to": ["5511999999999", "5521988887777"],
  "type": "text",
  "payload": {
    "message": "Seu código é 482910. Válido por 10 minutos."
  }
}

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 2,
    "messageIds": ["clxx123...", "clxx456..."],
  }
}

{
  "to": ["5511999999999"],
  "type": "template",
  "payload": {
    "templateId": "ID_DO_TEMPLATE",
    "variables": { "code": "482910", "name": "Maria" }
  }
}

{
  "from": "5511987654321",
  "to": ["5511999999999"],
  "type": "text",
  "payload": {
    "message": "Seu código é 482910. Válido por 10 minutos."
  }
}

GET /v1/sms/messages?page=1&limit=20
Authorization: Bearer sk_live_xxxxx

{
  "success": true,
  "data": [
    {
      "smsId": "clxx123...",
      "to": "5511999999999",
      "message": "Seu código é 482910...",
      "status": "DELIVERED",
      "sentAt": "2025-02-20T14:00:00.000Z",
      "deliveredAt": "2025-02-20T14:00:30.000Z"
    }
  ],
  "pagination": { "total": 42, "page": 1, "limit": 20, "totalPages": 3 }
}

GET /v1/sms/messages/:id
Authorization: Bearer sk_live_xxxxx

{
  "to": ["5511999999999"],
  "type": "text",
  "payload": {
    "message": "Lembrete amanhã às 9h."
  },
  "schedule": { "sendAt": "2025-03-01T09:00:00.000Z" }
}

POST /v1/sms/messages/:id/cancel
Authorization: Bearer sk_live_xxxxx

{
  "to": ["5511999999999"],
  "type": "text",
  "payload": { "message": "Promoção só hoje: 20% em toda a loja." },
  "options": { "speed": "slow" }
}

{
  "to": ["5511999999999"],
  "type": "text",
  "payload": { "message": "Seu código é 482910. Válido por 10 minutos." },
  "options": { "speed": "full" }
}