Skip to main content
GET
/
v1
/
sms
/
inbound
Listar SMS recebidos (MO)
curl --request GET \
  --url https://api.notifique.dev/v1/sms/inbound \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "provider": "<string>",
      "externalMoId": "<string>",
      "from": "<string>",
      "body": "<string>",
      "refer": "<string>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "relatedSmsLogId": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

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).

q
string

Busca no corpo (case insensitive) ou no remetente (se o valor tiver 8+ dígitos).

provider
enum<string>

Filtrar por provedor de SMS (valores inválidos são ignorados).

Available options:
SMS_DEV,
MOBIZON,
COMTELE,
SMS_BARATO
linked
string

true ou 1 para retornar só MO correlacionados a um SMS enviado pelo workspace (relatedSmsLogId preenchido).

dateFrom
string<date-time>

Início do intervalo em receivedAt (inclusive).

dateTo
string<date-time>

Fim do intervalo em receivedAt (inclusive).

Response

Lista de MO e paginação.

success
boolean
required
Example:

true

data
object[]
required
pagination
object
required