VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Mensagens

Entregue e lida

Marca as mensagens recebidas como entregues ou lidas, para o outro lado ver os tiques de confirmação.

Quando a tela do cliente carrega as mensagens, ela deve avisar a plataforma duas coisas: que as mensagens chegaram (entregues) e, quando o cliente de fato as vê, que foram lidas. A plataforma grava o horário e avisa quem enviou por WebSocket, para o app dele trocar um tique por dois e depois pintar de azul.

Pontos principais
  • Só mudam mensagens escritas pela outra parte. As suas próprias mensagens nunca são marcadas.
  • As duas rotas são idempotentes: chamar de novo não altera nada e responde count: 0.
  • Marcar como lida zera o unread_count da thread e diminui o contador de não lidas.
  • Sem corpo.
PATCH/api/v1/storefront/messages/threads/{id}/deliveredCliente

Marcar mensagens como entregues

Parâmetros de caminho

iduuidobrigatório
Id da thread.

Exemplo de requisição

bash
curl -X PATCH "$BASE_URL/api/v1/storefront/messages/threads/$THREAD_ID/delivered" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Entregas registradas
json
{ "message": "marked as delivered", "count": 2 }

Campos da resposta

messagestring
Texto fixo marked as delivered (em inglês, como o servidor devolve).
countinteger
Quantas mensagens passaram a entregues nesta chamada.
PATCH/api/v1/storefront/messages/threads/{id}/readCliente

Marcar mensagens como lidas

Parâmetros de caminho

iduuidobrigatório
Id da thread.
bash
curl -X PATCH "$BASE_URL/api/v1/storefront/messages/threads/$THREAD_ID/read" \
  -H "Authorization: Bearer $TOKEN"
200Leituras registradas
json
{ "message": "marked as read", "count": 2 }

Campos da resposta

messagestring
Texto fixo marked as read (em inglês, como o servidor devolve).
countinteger
Quantas mensagens passaram a lidas nesta chamada.

Erros

As duas rotas têm os mesmos erros.

StatusQuandoCorpo
400id não é UUID.{"error":"invalid id","detail":"id must be a valid UUID"}
401Sem token, ou token inválido.{"error":"missing authorization header"}
403A thread não é do cliente (ou não existe).{"error":"you are not a participant of this thread"}
500Falha ao gravar.{"error":"failed to mark read","detail":"..."} (ou failed to mark delivered)
Entregue antes de lida

A ordem natural é delivered assim que a lista de mensagens é carregada e read quando o cliente abre a conversa. Chamar só read funciona, mas o horário de entrega da mensagem fica vazio.

Veja também

  • Ler thread e contexto
  • Tempo real: digitando e presença
  • Listar e buscar threads
Anterior
Responder na thread
Próxima
Status da thread
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também