Indicadores de resposta

Os indicadores de resposta são sinais de conversação que permitem que uma das partes saiba que a outra já viu a mensagem e começou a preparar uma resposta. Normalmente exibidos como três pontos animados, os indicadores de resposta melhoram a experiência de conversação, reduzindo a incerteza e tornando as interações mais naturais e ágeis.

No momento, os indicadores de resposta estão disponíveis apenas para o WhatsApp.
Os indicadores de resposta podem ser apresentados em diferentes formatos, incluindo texto e notas de voz. As respostas em texto são conhecidas como indicadores de digitação.

Um indicador de resposta é automaticamente desativado quando uma mensagem de resposta é enviada ou após 25 segundos — o que ocorrer primeiro. Para evitar uma experiência ruim para o usuário, envie um indicador de resposta somente quando tiver a intenção de responder.

Após receber um webhook de mensagem recebida, você pode usar o message_uuid para:

  • marcar a mensagem como read, e
  • exibir um indicador de resposta para a outra parte

Essa abordagem garante que os indicadores de resposta sejam sempre contextuais, oportunos e vinculados a uma mensagem específica da conversa.

Para exibir um indicador de resposta, envie uma solicitação PATCH ao recurso de mensagem identificado por message_uuid.

O pedido:

  • atualiza o status da mensagem para read
  • inclui um replying_indicator objeto que controla se o indicador é exibido e que tipo de resposta está sendo preparada

Estrutura da solicitação

curl -X PATCH "${GEOSPECIFIC_MESSAGES_API_URL}/${MESSAGES_MESSAGE_ID}" \
  -H "Authorization: Bearer $JWT" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "status": "read",
    "replying_indicator": {
      "show": "true",
      "type": "text"
    }
  }'
Campo Descrição
status Atualiza o status da mensagem. Deve ser definido como “lida” para ativar os indicadores de resposta.
replying_indicator.show Ativa ou desativa o indicador de resposta.
replying_indicator.type Indica o tipo de resposta que está sendo preparada (por exemplo, texto).

Pontos de conexão da API Geospecific

A Messages API está disponível por meio de URLs base geoespecíficas. Você deve usar o endpoint correspondente à região em que seu aplicativo está provisionado:

  • Ásia-Pacífico (APAC): https://api-ap.vonage.com/v1
  • Europa (UE): https://api-eu.vonage.com/v1
  • Estados Unidos (EUA): https://api-us.vonage.com/v1

Nos exemplos, ${GEOSPECIFIC_MESSAGES_API_URL} representa uma dessas URLs base. Para exibir um indicador de resposta, você envia uma solicitação PATCH ao recurso de mensagem identificado pelo UUID da mensagem do cliente (message_uuid). Esse UUID é fornecido na carga útil do webhook da mensagem recebida.

Ponto de extremidade de ID da mensagem

O UUID da mensagem é anexado ao /messages caminho do recurso. Por exemplo:

https://api-us.vonage.com/v1/messages/3ca4b881-3e11-46bd-b491-76740a62639a

Este UUID identifica de forma exclusiva a mensagem recebida do cliente que você está marcando como lida e à qual está respondendo.

Resposta

Em caso de sucesso:

{
  "success"true
}