Conta
/v1/account
A API Local ficará obsoleta. Este ponto de extremidade não poderá mais ser usado para registrar números de telefone comercial e agora retornará o seguinte erro:
{
"code": 1005,
"title": "Access denied",
"details": "Unknown error: biz_link_on_prem_reg_blocked"
}
O nó account é usado para registrar seu cliente da WhatsApp Business API.
Vale ressaltar que o Coreapp será reiniciado se um novo número for registrado em um cluster que já tinha um.
Bordas
As seguintes bordas estão relacionadas ao nó:
| Borda | Descrição |
|---|---|
Depois de receber o código de registro pelo seu método de preferência, use esta borda para concluir o registro da conta. |
Antes de começar
Você precisará do seguinte:
- Tokens de autenticação para realizar login no serviço.
- Um número de telefone válido associado à conta do WhatsApp Business.
- Um nome de exibição do WhatsApp aprovado associado ao número de telefone.
Copiar o certificado codificado em Base64
Uma string do certificado codificada em Base64 é gerada para você e usada no processo de validação durante o registro do cliente da WhatsApp Business API.
- Acesse Configurações do negócio no Gerenciador de Negócios da Meta.
- No menu Contas, clique em Contas do WhatsApp e selecione a conta desejada na lista de Contas do WhatsApp se ela já não estiver destacada.
- Acesse a aba Configurações e clique no botão Gerenciador do WhatsApp.
- Na aba Números de telefone, seus telefones estarão listados. Clique no botão Visualizar do número de telefone para o qual você deseja um certificado.
Obter o certificado - Um diálogo pop-up exibirá a string do certificado em uma caixa cinza. Clique em Obter certificado.
Baixe a string do certificado. - Use a string do certificado no parâmetro
certao fazer o registro com o ponto de extremidadeaccount.
Consulte a documentação Nome de exibição para obter mais informações.
Limitações
- Você precisa usar a conta
adminpara registrar o app. - Se você estiver registrando sua conta novamente, o Coreapp deverá ser reiniciado quando o processo for concluído.
Como solicitar
Para solicitar um código de registro, faça uma chamada POST a este ponto de extremidade. Na chamada, adicione seu número de telefone e a string do certificado codificado em Base64. É possível receber o código por SMS ou por ligação de voz.
Exemplo
POST /v1/account
{
"cc": "COUNTRY_CODE",
"phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
"method": "sms" or "voice",
"cert": "VERIFIED_NAME_CERT_IN_BASE64",
"pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}
Dependendo da resposta recebida, o procedimento de registro poderá ser concluído ou exigir mais uma etapa. Se o processo for bem-sucedido, você receberá um dos seguintes códigos de status HTTP. Siga as instruções correspondentes à resposta recebida:
201 Created– a conta já existe. Você já se registrou e nenhuma ação é necessária.202 Accepted– a conta não existe. Dependendo do método selecionado na solicitação, confira seu número para SMS ou para ligação de voz e verifique se recebeu o código de registro. A resposta incluirá uma carga retornada contendo ovnamedecodificado com base no parâmetrocertpara que você confirme se o nome de exibição certo está sendo definido. Se estiver correto, acesse Verificar para finalizar o processo.
{
"account": [{
"vname": "decoded-vname-from-cert"
}]
}
Se algum erro for retornado, consulte Mensagens de erro e status para obter mais informações.
Parâmetros
| Nome | Descrição |
|---|---|
| Obrigatório. Código de país numérico do número de telefone que você está registrando. |
| Obrigatório. Número de telefone que você está registrando sem o código do país nem o sinal de adição ( |
| Obrigatório. Método de recebimento do seu código de registro |
| Obrigatório. Certificado codificado em Base64. |
| Opcional. PIN existente de seis dígitos: só é obrigatório quando a confirmação em duas etapas está habilitada na conta. |
Como alterar o PIN de confirmação em duas etapas
Para alterar o PIN de confirmação em duas etapas do número de telefone comercial:
- Carregue o portfólio empresarial no Gerenciador do WhatsApp.
- Se o painel Números de telefone não carregar automaticamente, navegue até Ferramentas da conta (ícone de caixa de ferramentas) > Telefones.
- Clique no ícone de configurações (engrenagem) do número de telefone.
- Clique em Confirmação em duas etapas.
- Clique em Alterar PIN e conclua o fluxo.
Para fazer a alteração, é preciso fornecer o PIN atual. Também é possível definir um novo PIN por meio das APIs:
Como desabilitar a confirmação em duas etapas
Para desabilitar a confirmação em duas etapas, siga as instruções para alterar o PIN, mas, por último, clique em Desabilitar a confirmação em duas etapas. Um email com um link será enviado ao endereço de email associado ao portfólio empresarial. Use o link para desabilitar a confirmação em duas etapas. Depois disso, é possível reabilitar a configuração ao definir um novo PIN.
Perguntas frequentes
Sim. Podemos configurar um novo número de telefone ou alterar o nome verificado quando você estiver pronto para entrar no ar.
Números para ligações gratuitas são permitidos, desde de que o código do país seja incluído. Isso ocorre porque os números para ligações gratuitas sem o código do país não podem ser identificados exclusivamente, ou seja, o mesmo número pode existir em dois países diferentes.
Além disso, há mais complexidades envolvidas ao usar números para ligações gratuitas. Em geral, se você telefonar para um número para ligações gratuitas com o código do país de dentro desse país, a ligação falhará. Isso significa que, se os clientes do seu país tentarem telefonar para o número exibido no contato da empresa (com o código do país incluído), eles não conseguirão entrar em contato com você. Caso isso seja um problema, você deverá informá-los explicitamente.
Leia mais sobre números para ligações gratuitas aqui.
Se você fizer backup da sua configuração atual e restaurá-la na nova máquina, as informações de registro deverão ser movidas juntamente com o restante da implementação. Consulte a documentação sobre Configurações de backup e restauração para obter mais informações.
Você pode registrar novos números de telefone e excluir o antigo em sua conta do WhatsApp no Gerenciador de Negócios do Facebook.
- Em sua conta do WhatsApp, acesse Configurações.
- Clique no Gerenciador do WhatsApp.
- Selecione a guia Números de telefone. Esse é o local onde é possível gerenciar todos os números de telefone da conta.
Se o registro falhar com a opção “SMS" devido a muitas tentativas, e uma mensagem de “acesso negado" for exibida, tente fazer o registro com a opção “chamada de voz"
Infelizmente, será necessário usar um número de telefone que possa receber SMS ou chamadas de voz para que possamos enviar o código de registro. Códigos de registro manuais já foram permitidos, mas não são mais. Números de telefone que usaram códigos de registro manuais anteriormente continuarão funcionando conforme necessário. Para novos números de telefone, os códigos de registro só serão enviados por meio de SMS ou chamadas de voz.
Caso queira usar um número 1800 ou um número para ligações gratuitas, leia este guia.