Skip to main content

O que é

Uma conta do WhatsApp Business (WABA) contém os números de telefone, modelos e configurações de mensagens usados por uma empresa. Use estas APIs para descobrir as WABAs conectadas à sua conta YCloud e verificar se cada conta está pronta para mensagens em produção.

Antes de começar

  • Conecte ou registre uma WABA com a YCloud.
  • Armazene sua chave de API da YCloud com segurança.
  • Saiba se você precisa de todas as contas conectadas ou de um ID de WABA específico.

Como funciona

  1. Liste WABAs para descobrir seus IDs.
  2. Recupere uma WABA quando precisar do seu estado atual de empresa, verificação, pagamento, restrição ou limite de mensagens.
  3. Armazene o ID da WABA junto com os números de telefone e modelos que pertencem a ela.
A API é somente leitura. A integração e a correção de problemas da conta podem exigir ações na YCloud ou no Gerenciador de Negócios da Meta.

Requisição

Listar WABAs

GET /whatsapp/businessAccounts
Use filter.accountReviewStatus quando precisar de contas em um estado de análise específico.

Recuperar uma WABA

GET /whatsapp/businessAccounts/{id}

Resposta

Limites de registro de números de telefone

Os endpoints de listagem e recuperação não retornam valores históricos para maxPhoneNumbersPerBusiness ou maxPhoneNumbersPerWaba. Inscreva-se em whatsapp.business_account.updated e processe updateEvent=BUSINESS_CAPABILITY_UPDATE para receber os valores que a Meta inclui em cada atualização. Atualmente, a Meta informa os dois campos em atualizações separadas. Não os trate como mutuamente exclusivos: processe cada campo de forma independente e aceite ambos se uma atualização futura os incluir juntos. O valor 0 é válido. Armazene esses valores no seu sistema se precisar de histórico ou do estado mais recente conhecido.

Prontidão da conta

Não trate uma recuperação bem-sucedida como prova de que todos os números de telefone podem enviar mensagens. Verifique o estado da WABA junto com o registro do número de telefone selecionado, o status do modelo de mensagem, o acesso ao produto e os limites de mensagens.

Limites e solução de problemas

  • Uma WABA não encontrada geralmente significa que ela não está conectada à conta YCloud atual ou que o ID está incorreto.
  • Os estados de análise, verificação, restrição e pagamento são controlados pela Meta e podem mudar de forma assíncrona.
  • Faça cache de identificadores estáveis, mas recupere o status novamente antes de diagnosticar um problema de integração ou envio.

Listar WABAs

Inspecione a paginação, os filtros e o esquema completo da página.

Recuperar uma WABA

Inspecione todos os campos de status e restrição da conta.