Skip to main content
GET
/
v1
/
sms
/
messages
Listar SMS
curl --request GET \
  --url https://api.notifique.dev/v1/sms/messages \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "smsId": "clxx123...",
      "to": "5511999999999",
      "message": "Olá!",
      "status": "DELIVERED",
      "sentAt": "2025-02-16T12:00:00.000Z",
      "deliveredAt": "2025-02-16T12:00:05.000Z",
      "failedAt": null,
      "scheduledFor": null,
      "errorMessage": null,
      "createdAt": "2025-02-16T11:59:58.000Z"
    }
  ],
  "pagination": {
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  }
}

Authorizations

​
Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Query Parameters

​
page
string

Página (padrão 1).

​
limit
string

Itens por página (padrão 20, máx. 100).

​
fromDate
string<date-time>

Início do intervalo (filtro em createdAt, inclusive).

​
toDate
string<date-time>

Fim do intervalo (filtro em createdAt, inclusive).

​
status
string

Um ou mais status separados por vírgula: QUEUED, SCHEDULED, SENT, PROCESSING, DELIVERED, FAILED, CANCELLED. Valores inválidos são ignorados.

Response

Lista de SMS e paginação.

​
success
boolean
required
Example:

true

​
data
object[]
required

Cada item tem os mesmos campos que GET /v1/sms/messages/{id} em data (sem campos extras).

​
pagination
object
required