Consulta de Respostas (Replies)

Este endpoint permite consultar as mensagens recebidas (replies/MO) enviadas pelos destinatários em resposta às suas mensagens SMS.

Endpoint

POST https://pointer-sms-api.pontaltech.com.br/v1/reply

Requisição

A rota suporta dois modos de consulta: por IDs de mensagem ou por período (com filtros opcionais).

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token no formato `Basic <credenciaisnabase64>`
Content-Type	string	Sim	application/json

Modo 1 — Busca por IDs

A consulta de replies por ID só pode ser feita para mensagens enviadas a partir de 26/06/2026.

Consulta replies vinculadas a mensagens específicas pelo UUID.

Body

{
  "ids": [
    "85c6e21b-e4e8-4ba1-8293-e99f324785af",
    "77536a8b-4268-4137-95af-746141c01ab7"
  ]
}

Campos

Campo	Tipo	Obrigatório	Descrição
ids	array string	Sim	Lista de UUIDs das mensagens (máximo 1000)

Modo 2 — Busca por Período

Consulta replies dentro de um intervalo de datas, com filtros opcionais.

Body

{
  "startDate": "2026-06-20",
  "endDate": "2026-06-26",
  "mobile": "11999999999",
  "mailingId": "456",
  "classify": "OUTROS",
  "page": 1,
  "limit": 100
}

Campos

Campo	Tipo	Obrigatório	Descrição
startDate	string	Sim	Data inicial do período de consulta (formato ISO 8601: `YYYY-MM-DD`)
endDate	string	Sim	Data final do período de consulta (formato ISO 8601: `YYYY-MM-DD`)
mobile	string	Não	Filtrar pelo número do remetente da reply
mailingId	string	Não	Filtrar pelo ID do mailing associado à mensagem original
classify	string	Não	Filtrar pela classificação da reply (ex: `OUTROS`, `positivo`, `negativo`)
page	integer	Não	Número da página para paginação (padrão: 1)
limit	integer	Não	Limite de registros por página (padrão: 1000, máximo: 1000)

Resposta de Sucesso (200)

{
  "replies": [
    {
      "message": "Quero mais informações",
      "reference": "7",
      "received": "2026-06-21T04:44:29.000Z",
      "from": "11999999999",
      "classify": "OUTROS",
      "mailingId": "",
      "mailingName": "SmsMailing",
      "accountId": "",
      "accountName": ""
    }
  ]
}

Campos da Resposta

Campo	Tipo	Descrição
message	string	Conteúdo da mensagem recebida (reply)
reference	string	Referência do cliente associada à mensagem original
received	datetime (UTC)	Data e hora em que a resposta foi recebida
from	string	Número do remetente (quem respondeu)
classify	string	Classificação da reply (ex: `OUTROS`, `positivo`, `negativo`)
mailingId	string	ID do mailing associado à mensagem original
mailingName	string	Nome do mailing associado
accountId	string	ID da conta associada
accountName	string	Nome da conta associada

Callback de Reply

A Pontaltech envia callbacks automáticos para mensagens recebidas (replies). O callback é enviado para o urlCallback informado no envio original.

Exemplo de Payload do Callback de Reply

{
  "type": "api_reply",
  "replies": [
    {
      "messageId": "85c6e21b-e4e8-4ba1-8293-e99f324785af",
      "reference": "1782403716",
      "message": "Quero mais informações",
      "from": "11999999999",
      "received": "2026-06-26T21:56:18.000Z",
      "classify": "OUTROS",
      "value": "0.01"
    }
  ]
}

Campos do Callback

Campo	Tipo	Descrição
type	string	Tipo do callback (`api_reply`)
messageId	string	UUID da mensagem original que recebeu a resposta
reference	string	Referência do cliente associada à mensagem original
message	string	Conteúdo da resposta recebida
from	string	Número do remetente (quem respondeu)
received	datetime (UTC)	Data e hora em que a resposta foi recebida
classify	string	Classificação da reply
value	string	Valor tarifado da reply

Resumo — Como obter respostas dos usuários

Método	Disponibilidade	Recomendação
Callback automático (`api_reply`)	✅ Disponível	Recomendado (tempo real)
Consulta via API (`/v1/reply`)	✅ Disponível	Para consultas históricas e reconciliação

O callback de reply é enviado apenas para mensagens cujo envio original incluiu o campo urlCallback. Mensagens sem callback configurado só podem ser consultadas via endpoint.

Exemplos de Requisição cURL

Busca por IDs

curl -X POST "https://pointer-sms-api.pontaltech.com.br/v1/reply" \
  -H "Authorization: Basic <credenciaisnabase64>" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["85c6e21b-e4e8-4ba1-8293-e99f324785af"]
  }'

Busca por Período com Filtros

curl -X POST "https://pointer-sms-api.pontaltech.com.br/v1/reply" \
  -H "Authorization: Basic <credenciaisnabase64>" \
  -H "Content-Type: application/json" \
  -d '{
    "startDate": "2026-06-20",
    "endDate": "2026-06-26",
    "mobile": "11999999999",
    "mailingId": "456",
    "classify": "OUTROS",
    "page": 1,
    "limit": 100
  }'

Respostas de Erro

Status	Body	Condição
400	`"Campo ids obrigatório"`	Body sem `ids` nem `startDate`/`endDate`
400	`"ids deve ser um array com no máximo 1000 itens"`	`ids` inválido ou com mais de 1000 itens
400	`"Campos startDate e endDate são obrigatórios"`	Modo por período sem datas
400	`"limit máximo de 1000"`	`limit` maior que 1000
401	`"Credenciais invalidas"`	Autenticação falhou
429	`retryAfter`	Rate limit excedido
500	`"Erro contatar suporte"`	Erro interno no servidor

Referência de API

Rotas

Endpoint

Requisição

Headers

Modo 1 — Busca por IDs

Body

Campos

Modo 2 — Busca por Período

Body

Campos

Resposta de Sucesso (200)

Campos da Resposta

Callback de Reply

Exemplo de Payload do Callback de Reply

Campos do Callback

Resumo — Como obter respostas dos usuários

Exemplos de Requisição cURL

Busca por IDs

Busca por Período com Filtros

Respostas de Erro

​Endpoint

​Requisição

​Headers

​Modo 1 — Busca por IDs

​Body

​Campos

​Modo 2 — Busca por Período

​Body

​Campos

​Resposta de Sucesso (200)

​Campos da Resposta

​Callback de Reply

​Exemplo de Payload do Callback de Reply

​Campos do Callback

​Resumo — Como obter respostas dos usuários

​Exemplos de Requisição cURL

​Busca por IDs

​Busca por Período com Filtros

​Respostas de Erro

Endpoint

Requisição

Headers

Modo 1 — Busca por IDs

Body

Campos

Modo 2 — Busca por Período

Body

Campos

Resposta de Sucesso (200)

Campos da Resposta

Callback de Reply

Exemplo de Payload do Callback de Reply

Campos do Callback

Resumo — Como obter respostas dos usuários

Exemplos de Requisição cURL

Busca por IDs

Busca por Período com Filtros

Respostas de Erro