API de Nuvem

Plataforma do WhatsApp Business > Cloud API > Referência

Registro

Para usar o número de telefone comercial na API de Nuvem, é preciso registrá-lo. Faça o registro nos seguintes cenários:

  • Criação de conta: ao implementar a API, é preciso registrar o número de telefone comercial a ser usado para enviar mensagens. Para adicionar uma camada adicional de segurança às contas, exigimos o uso da confirmação em duas etapas durante a criação.
  • Alteração de nome: nesse caso, o telefone já foi registrado, e você quer alterar o nome de exibição. Para isso, você precisa solicitar a alteração de nome no Gerenciador do WhatsApp. Depois que o nome for aprovado, é necessário registrar o telefone novamente com o novo nome.
  • Migração de número da API Local para a API de Nuvem. Consulte Exceção na migração.

Antes de fazer o registro, você precisa verificar o número de telefone.

Exceção na migração

Se você estiver migrando um número de telefone da API Local para a API de Nuvem, precisará cumprir etapas adicionais antes de registrar um número com a API de Nuvem. Consulte Migrate Between On-Premises and Cloud API para ver o processo completo.

Registrar um número de telefone comercial

Para registrar um número de telefone comercial, faça uma chamada POST a PHONE_NUMBER_ID/register. Lembre-se de incluir os parâmetros abaixo.

Ponto de extremidadeAutenticação

PHONE_NUMBER_ID/register

(consulte Get Phone Number ID)

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

Limitações

As solicitações ao ponto de extremidade de registro estão sujeitas ao limite de 10 solicitações por número de telefone comercial em um período de 72 horas.

Quando você fizer uma solicitação de registro, verificaremos quantas solicitações desse tipo você fez para o número de telefone nas últimas 72 horas. Se você já tiver feito 10 solicitações, a API retornará o código de erro 133016, e não será possível registrar o número nas 72 horas subsequentes.

Parâmetros

NomeDescrição

messaging_product

Obrigatório.

Serviço de mensagens usado. Defina como "whatsapp".

pin

Obrigatório.

Se a confirmação em duas etapas estiver habilitada no número de telefone verificado, defina esse valor como o PIN de verificação com seis dígitos. Se não lembrar do PIN, você pode atualizá-lo.


Se a confirmação em duas etapas não estiver habilitada, defina esse valor como um número de seis dígitos. Esse será o PIN para confirmação em duas etapas do número de telefone comercial.

data_localization_region

Opcional.


Se for incluído, o armazenamento local será habilitado no número de telefone comercial. O valor deve ser um código de país ISO 3166 de duas letras (por exemplo, IN), indicando a região onde você quer que os dados em repouso sejam armazenados.


Valores compatíveis:


APAC

  • Austrália: AU
  • Indonésia: ID
  • Índia: IN
  • Japão: JP
  • Singapura: SG
  • Coreia do Sul: KR

Europa

  • Alemanha: DE
  • Suíça: CH
  • Reino Unido: GB

LATAM

  • Brasil: BR

EMEA

  • Barein: BH
  • África do Sul: ZA
  • Emirados Árabes Unidos: AE

NORAM

  • Canadá: CA

Depois que o recurso for habilitado, ele não poderá ser desabilitado nem alterado diretamente. Em vez disso, será necessário excluir o registro do número de telefone e registrá-lo novamente sem esse parâmetro (para desabilitar), ou incluir o parâmetro com o novo código de país (para alterar).


Para habilitar o armazenamento local em um número de telefone que já foi registrado, você deve excluir o registro, depois registrar o número novamente e incluir esse parâmetro.

Exemplo de solicitação sem armazenamento local

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834"
}

Exemplo de solicitação com armazenamento local

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834",
  "data_localization_region": "CH"
}

All API calls require authentication with access tokens.

Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup.

Solution Partners must authenticate themselves with an access token with the whatsapp_business_messaging and whatsapp_business_management permissions. See System User Access Tokens for information.

Excluir o registro de um número de telefone comercial

Após a exclusão do registro, o número de telefone comercial não poderá mais ser usado com a API de Nuvem e terá o armazenamento local desabilitado.

O cancelamento do registro não exclui o número nem o histórico de mensagens dele. Para excluir um número e o histórico dele, consulte Números de telefone: Como excluir um número de telefone da WABA.

Para excluir o registro de um número de telefone comercial, faça uma chamada POST a PHONE_NUMBER_ID/deregister:

Ponto de extremidadeAutenticação

PHONE_NUMBER_ID/deregister

(consulte Get Phone Number ID)

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

Limitações

As solicitações ao ponto de extremidade de cancelamento do registro estão sujeitas ao limite de 10 solicitações por número de telefone comercial em um período de 72 horas.

Quando você fizer uma solicitação para cancelar o registro, verificaremos quantas solicitações desse tipo você fez para o número de telefone nas últimas 72 horas. Se você já tiver feito 10 solicitações, a API retornará o código de erro 133016, e não será possível cancelar o registro do número nas 72 horas subsequentes.

Exemplo

Exemplo de solicitação:

curl -X POST \  
 'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/deregister' \  
 -H 'Authorization: Bearer ACCESS_TOKEN'

A resposta bem-sucedida tem a seguinte aparência:

{
  "success": true
}

Veja também