Gateway-API
  1. Reports
Gateway-API
  • Gateway - API
    • Contacts
      • List
    • Routes
      • Routes
    • Reports
      • Received Messages Report
        GET
      • Sent Messages Report
        GET
      • Messages Requests Report
        GET
      • Cancel Messages Request
        POST
    • 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
        • MessageRequestsReportResult
        • CancelMessagesRequestInput
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
  • Default module
    • Raiz
  1. Reports

Messages Requests Report

GET
/api/reports/messages/requests
Retorna relatório paginado de requisições de mensagens agrupadas por RequestId.
Funcionalidades:
Agrupamento por RequestId (uma linha por requisição)
Filtros por período, conteúdo, tag, custom e requestId
Paginação com skip/limit
Autenticação via X-API-Key header
Regras:
startDate padrão: 2 dias atrás (UTC)
endDate padrão: data atual (UTC)
Retorna apenas dados do usuário autenticado
Ordenação: Schedule DESC, CreatedAt DESC

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Sucesso
Body

🟠400Bad Request
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.comtele.com.br/api/reports/messages/requests?startDate&endDate&skip&limit&content&custom&tag&requestId' \
--header 'X-API-Key;'
Response Response Example
200 - OK
{
    "hasError": false,
    "message": null,
    "object": [
        {
            "userId": 123,
            "content": "Olá! Aproveite 50% OFF",
            "createdAt": "2024-01-15T10:30:00Z",
            "sentAt": "2024-01-15T10:30:05Z",
            "requestCount": 1000,
            "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "schedule": "2024-01-15T10:30:00Z",
            "custom": "campaign-2024",
            "tag": "promocao",
            "productId": 1,
            "product": "SMS",
            "routeId": 5,
            "route": "Rota Brasil - TIM"
        }
    ],
    "totalRecords": 150,
    "errors": null
}
Modified at 2025-12-18 18:28:07
Previous
Sent Messages Report
Next
Cancel Messages Request
Built with