Skip to main content
GET
Listar SMS recebidos

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

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

Opções disponíveis:
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).

Resposta

Lista de MO e paginação.

success
boolean
obrigatório
Exemplo:

true

data
object[]
obrigatório
pagination
object
obrigatório