Sent Messages Report

GET

/reports/messages/sent

Este endpoint permite consultar o histórico de mensagens enviadas via API, abrangendo canais como SMS, RCS (básico, card, carrossel, arquivo), entre outros. Os resultados incluem informações completas sobre cada envio, como conteúdo, destinatário, status de entrega, agendamento, rota utilizada, tags, entre outros.

Ideal para compor dashboards, gerar relatórios personalizados ou integrar o status de entrega ao seu sistema interno de notificações e acompanhamento.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/reports/messages/sent?startDate=2024-01-01&limit=10' \
--header 'x-api-key: <api-key>'

Response Example

{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": [
        {
            "id": "string",
            "receiver": "string",
            "content": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "sentAt": "2019-08-24T14:15:22Z",
            "requestId": "string",
            "schedule": "2019-08-24T14:15:22Z",
            "custom": "string",
            "tag": "string",
            "status": "string",
            "statusDetails": "string",
            "product": "string",
            "route": "string"
        }
    ]
}

Modified at 2025-11-06 13:43:43

Received Messages Report

Send RCS (File) Message