Gateway-API
  1. Reports
Gateway-API
  • Gateway - API
    • Contacts
      • List
    • Routes
      • Routes
    • Reports
      • Received Messages Report
        GET
      • Sent Messages Report
        GET
    • RCS
      • Send RCS (File) Message
      • Send RCS (Carrossel) Message
      • Send RCS (Card) Message
      • Send RCS (Basic) Message
    • SMS
      • Send SMS Message
    • Schemas
      • Core
        • CoreResult
      • Contacts
        • Contact
      • Routes
        • Routes
      • Reports
        • Received
        • Sent
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
  • Default module
    • Raiz
  1. Reports

Received Messages Report

GET
/reports/messages/received
Este endpoint permite consultar respostas recebidas de mensagens enviadas anteriormente via SMS ou RCS. Sempre que um destinatário responde diretamente a uma mensagem recebida, o conteúdo da resposta é armazenado e pode ser acessado por este relatório.
É útil para aplicações que esperam interações do usuário, como confirmações, feedbacks, códigos, ou qualquer outra forma de resposta via texto.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/reports/messages/received?startDate=2024-06-01&limit=10' \
--header 'x-api-key: <api-key>'
Response Response Example
{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": [
        {
            "sender": "string",
            "content": "string",
            "receivedAt": "2019-08-24T14:15:22Z",
            "messageId": "string"
        }
    ]
}
Modified at 2025-11-06 13:44:10
Previous
Routes
Next
Sent Messages Report
Built with