Skip to main content

O que é

Assine whatsapp.meta_business_agent.handover.updated. Você recebe este evento quando a YCloud processa um callback suportado de transferência/controle para um Meta Business Agent criado via API. Ele relata a transferência de controle, não o resultado de uma atribuição na Inbox ou de uma mensagem de transferência personalizada. Diferente dos dois eventos Echo, este evento mantém intencionalmente o objeto whatsappMetaBusinessAgent porque os metadados do Agent e de controle fazem parte do contrato de handover.

Antes de começar

  1. Faça o onboarding do Agent por meio da API REST pública.
  2. Assine um endpoint de webhook ativo na mesma conta para whatsapp.meta_business_agent.handover.updated.
  3. Verifique o YCloud-Signature em relação ao corpo bruto da solicitação, aceite cada evento de forma duradoura e processe-o de maneira idempotente.
Agents criados pelo Console não emitem este webhook para clientes. A sincronização da Inbox desses agentes é um fluxo separado.
Consulte Configurar webhooks para obter instruções sobre a configuração do endpoint.

Como funciona

Todos os exemplos usam identificadores de espaço reservado. Roteie pelo type externo e leia whatsappMetaBusinessAgent, não whatsappMessage, whatsappEchoMessage ou data. Desduplique envios repetidos usando o id externo. O timestamp aninhado é um número inteiro em milissegundos Unix; createTime é uma string RFC 3339.
  • Atualmente, controlState é APP_CONTROL_TAKEN para callbacks suportados de handover do Agent via API.
  • consumerPhoneNumber vem de sender.phone_number do callback de transferência e é normalizado para E.164 quando válido. Não se trata do número comercial nem de phoneNumberId.
  • O contrato de handover atual não expõe recipientUserId ou parentRecipientUserId. Identidades de consumidores ausentes não são recuperadas a partir de um callback de mensagem vizinho.
  • Para o exemplo control_passed abaixo, actor identifica o app proprietário anterior, não o funcionário destinatário.
  • reason são metadados opcionais do provedor. Trate-os como uma string aberta, não como um enum fixo.
  • Esta não é uma notificação para cada solicitação take, release, Set Live ou Set Draft. Callbacks de controle processados enquanto o Agent estiver em Draft são ignorados.
O payload não inventa a identidade de um consumidor. consumerPhoneNumber é omitido quando o callback não fornece um número de telefone válido, e nenhum BSUID é inferido de mensagens adjacentes. phoneNumberId identifica o número comercial, que pode atender a vários clientes.
Não trate este evento como prova de que um funcionário foi atribuído ou que uma mensagem de transferência personalizada foi enviada ou entregue.

Solicitação

A YCloud envia esses corpos JSON em solicitações HTTP POST para a URL de Webhook configurada.

Resposta

Retorne uma resposta 2xx após aceitar o evento de forma duradoura. Processe operações lentas de forma assíncrona.

O Agent transfere o controle para sua aplicação

Solicitação

APP_CONTROL_TAKEN relata a transferência de controle, não uma atribuição de funcionário na Inbox ou a entrega de uma mensagem de transferência personalizada. Neste exemplo, actor é o ID do app proprietário anterior.

Resposta

Explicação

Use consumerPhoneNumber para correlacionar a transição de controle ao consumidor quando estiver presente. Não infira uma atribuição na Inbox ou entrega de mensagem a partir deste evento.

Exemplos relacionados