Este documento registra as alterações realizadas na Plataforma do WhatsApp Business.
API de Nuvem
API de Nuvem
Todas as APIs
API de Gerenciamento do WhatsApp Business
Alterações na versão 21.0 da API de Nuvem
package_name
e signature_hash
devem ser definidos na matriz supported_apps
ao criar modelos de autenticação de preenchimento automático com um toque e zero toque.storage_configuration
ao ponto de extremidade POST /<WHATSAPP_BUSINESS_PHONE_NUMBER>/settings, que pode ser usado para habilitar ou desabilitar o armazenamento local.data_localization_region
do ponto de extremidade POST /<WHATSAPP_BUSINESS_PHONE_NUMBER>/register.API de Nuvem
API de Nuvem
API de Nuvem
API de Nuvem
API de Nuvem
API de Nuvem
API de Gerenciamento do WhatsApp Business
API de Nuvem
API de Nuvem
API de Nuvem, API Local
API de Nuvem
biz_opaque_callback_data
de 256 para 512.API de Gerenciamento do WhatsApp Business
cta_url_link_tracking_opted_out
ao nó WhatsApp Message Template para habilitar/desabilitar o rastreamento de cliques no botão.UTILITY
.API de Gerenciamento do WhatsApp Business
API de Nuvem
health_status
a diversos nós para verificar o status de integridade de envio de mensagens.biz_opaque_callback_data
a mensagens em formato livre para incluir strings arbitrárias em webhooks de mensagens.API de Gerenciamento do WhatsApp Business
API de Gerenciamento do WhatsApp Business, API de Nuvem, API Local
Flows
API de Nuvem
data_localization_region
ao ponto de extremidade WhatsApp Business Phone Number > Register para habilitar o armazenamento local.API de Gerenciamento do WhatsApp Business, API de Nuvem, API Local
code_expiration_minutes
(em vez do padrão de 10 minutos) para determinar se a mensagem de modelo entregue deve exibir um botão de preencher automaticamente ou um botão de copiar código.code_expiration_minutes
, quando o valor estiver presente. Caso contrário, esse processo ocorrerá após 10 minutos.API de Nuvem
limited_time_offer
.API de Nuvem
ctwa_clid
ao objeto referral
em webhooks de mensagens. Informa o número de identificação do clique, gerado quando o usuário toca em um anúncio de clique para o WhatsApp a fim de enviar a mensagem.API de Nuvem, API Local
API de Gerenciamento do WhatsApp Business
add_security_recommendation
e code_expiration_minutes
no valor de component
.200
se o usuário identificado pelo token não tiver recebido o acesso adequado à conta do WhatsApp Business.API de Nuvem
API de Nuvem, API Local
API de Nuvem, API Local
API de Gerenciamento do WhatsApp Business
template_analytics
(em versão beta).Ferramentas
API de Gerenciamento do WhatsApp Business
Cadastro Incorporado
API de Gerenciamento do WhatsApp Business
VERIFIED
por 28 dias (antes eram 14 dias).API de Nuvem
Gerenciamento do WhatsApp Business
Ferramentas
Gerenciamento do WhatsApp Business
2494100
da API de Gerenciamento do WhatsApp Business para indicar que um número de telefone comercial está temporariamente em modo de manutenção.API de Nuvem
Ferramentas
API de Nuvem
132015
em vez de 132001
.132016
em vez de 132001
.API Local
2061
será retornado.2062
será retornado.API de Gerenciamento do WhatsApp Business
API de Nuvem
API Local
API de Gerenciamento do WhatsApp Business
account_alerts
.AUTHENTICATION
, MARKETING
ou UTILITY
.API de Gerenciamento do WhatsApp Business
hsm_id
ao ponto de extremidade DELETE WhatsApp Business Account > Message Templates. Quando usado, ele exclui um único modelo correspondente ao ID fornecido (em vez de excluir todos os modelos que correspondem ao nome fornecido).API de Nuvem
last_onboarded_time
ao nó WhatsApp Business Phone Number. Isso indica quando um usuário criou um número de telefone comercial na conta do WhatsApp Business ao concluir o fluxo de cadastro incorporado.API de Nuvem
Cadastro Incorporado
API de Gerenciamento do WhatsApp Business, API de Nuvem, API Local
allow_category_change
ao ponto de extremidade POST WhatsApp Business Account > Message Templatesprevious_category
aos modelos de mensagem do WhatsApp.API de Gerenciamento do WhatsApp Business
template_category_update
. Ao assinar esse campo, você receberá um webhook com a categoria nova e anterior do modelo sempre que houver alterações.API de Nuvem
API Local
API de Nuvem, API Local
API de Gerenciamento do WhatsApp Business
API de Nuvem, API Local
API de Gerenciamento do WhatsApp Business, API de Nuvem
API de Nuvem
AUTHENTICATION
MARKETING
UTILITY
code
e details
."code":100
) usava vários títulos únicos que indicavam a natureza do erro. Agora, todos os erros com o código 100 terão Invalid parameter
como título. Os títulos antigos que descreviam a natureza do código de erro 100 foram transferidos para a propriedade details
. Essa alteração também ocorreu nas cargas de webhooks que descrevem respostas de erro com o código 100.Webhooks da API de Nuvem
errors
nos webhooks disparados pelos erros de solicitação na v16.0 ou em versões posteriores agora inclui as propriedades message
e error_data.details
, e os valores title
foram alterados para vários códigos de erro. Agora, os objetos errors
possuem a seguinte estrutura e dados:[ { "code": <CODE>, "title" : "<TITLE>", "message": "<MESSAGE>", "error_data": { "details": "<DETAILS>" } }, ... ]
title
foi atualizado para os seguintes códigos de erro. Os valores antigos agora aparecem em error_data.details
.
130470
agora é Re-engagement message
.130429
agora é Rate limit hit
.131045
agora é Incorrect certificate
.131031
agora é Business Account locked
.131053
agora é Media upload error
.131027
agora é Something went wrong
.131042
agora é Business eligibility payment issue
.131026
agora é Message Undeliverable
.131000
agora é Something went wrong
.message
é igual ao da title
, o que indica o título do código de erro. Essa propriedade mapeia para a propriedade message
nas cargas de resposta de erro da API.error_data.details
inclui títulos de códigos de erro listados acima e descreve a causa subjacente do erro. Esse valor mapeia para a propriedade details
nas cargas de resposta de erro da API.Essas alterações são refletidas nas seguintes propriedades errors
em webhooks relacionados a erros:
entry.changes.value.errors
entry.changes.value.messages.errors
entry.changes.value.statuses.errors
API de Nuvem
Agora, empresas não verificadas podem iniciar até 250 conversas em um período contínuo de 24 horas.
Aplicável a todas as versões da API de Nuvem.
Adicionamos um novo campo phone_number_id
opcional ao ponto de extremidade de mídia. Se você incluir esse parâmetro e uma identificação de número de telefone comercial, a operação só será processada se a identificação for a mesma do número de telefone no qual a mídia foi carregada.
O cache HTTP de mídia da API de Nuvem saiu da versão beta e está disponível para todos.
Agora, quando uma notificação de webhook apresentar falhas, a API de Nuvem fará uma nova tentativa de entrega por até 7 dias em vez de 30. Consulte Webhooks Delivery Failure.
Aplicável a todas as versões.
template_performance_metrics
. Envia notificações semanais sobre as métricas de desempenho do modelo, incluindo a contagem de mensagens enviadas e de mensagens abertas, além dos principais motivos de bloqueio.Aplicável a todas as versões.
Novo campo account_alerts
:
account_alerts
. Envia notificações sobre alertas do número de telefone comercial, da conta do WhatsApp Business e da empresa.Novos valores do campo account_update
:
account_update.events
: ACCOUNT_DELETED
. Indica que um número de telefone teve o registro cancelado ou foi excluído de uma conta do WhatsApp Business.message_template_status_update.events
: PENDING_DELETION
. Indica que o modelo de mensagem foi marcado para exclusão.Exemplos de notificações de Webhooks enviadas quando os novos eventos são disparados:
ACCOUNT_DELETED
: conta do WhatsApp Business excluídaPENDING_DELETION
: modelo de mensagem com exclusão pendenteAdicionamos os seguintes campos ao nó da conta do WhatsApp Business:
country
(aplicável a v15.0+
)ownership_type
(aplicável a v15.0+
)business_verification_status
(aplicável a todas as versões)Aplicável a partir da versão 15.0.
Adicionamos as seguintes opções de filtro ao ponto de extremidade de contas do WhatsApp Business de clientes da empresa:
creation_time
da conta do WhatsApp Business usando os operadores GREATER_THAN
, LESS_THAN
ou IN_RANGE
.ownership_type
da conta do WhatsApp Business usando os operadores EQUAL
ou IN
.Adicionamos as seguintes opções de filtro ao ponto de extremidade de contas do WhatsApp Business pertencentes à empresa:
creation_time
da conta do WhatsApp Business usando os operadores GREATER_THAN
, LESS_THAN
ou IN_RANGE
.ownership_type
da conta do WhatsApp Business usando os operadores EQUAL
ou IN
.country
da conta do WhatsApp Business usando os operadores EQUAL
ou IN
.Aplicável a partir da versão 15.0.
Adicionamos os seguintes campos de nó de Número de telefone do WhatsApp Business:
is_official_business_account
messaging_limit_tier
Além disso, é possível filtrar o ponto de extremidade de números de telefone da conta do WhatsApp Business por is_official_business_account
.
Agora a API de Nuvem é compatível com a combinação de até 500 (antes era 350) mensagens enviadas e recebidas por segundo (incluindo mensagens de texto e de mídia) mediante solicitação. Consulte a seção Taxa de transferência de dados para ver mais informações.
Caso você já tenha 350 mps, o limite aumentará para 500 mps automaticamente. Caso você tenha solicitado 350 mps, mas o processo não tenha sido concluído, você receberá 500 mps ao concluir.
Estamos fazendo um teste beta do cache HTTP de mídia na API de Nuvem. Se você é um parceiro de soluções, consulte Enviar mensagens em formato livre: Cache HTTP de mídia e saiba como usar cabeçalhos nas respostas do servidor a fim de solicitar o cache dos ativos para reutilização em mensagens futuras.
Agora a API de Nuvem é compatível com legendas em documentos enviados para clientes e recebidos. Consulte Media Object na referência de Media.
Agora as contas do WhatsApp Business podem ter até 6.000 modelos de mensagem se a conta principal tiver sido verificada e pelo menos uma das contas tiver um número de telefone comercial com um nome de exibição aprovado.
Como parte da alteração, as versões traduzidas dos modelos passaram a ser contabilizados no limite de modelos da conta do WhatsApp Business.
Agora as empresas localizadas na Índia podem usar cartão de crédito para pagar pelas mensagens enviadas por meio da plataforma. Consulte como adicionar um cartão de crédito à sua conta da Plataforma do WhatsApp Business.
Agora é possível migrar números de telefone das e para as contas do WhatsApp Business na API de Nuvem. Consulte como migrar o número de telefone para uma WABA diferente.
Apenas na API de Nuvem.
Agora é possível usar URLs de retorno de chamada diferentes em cada conta do WhatsApp Business sem precisar criar um app único para cada uma delas. Consulte Substituir a URL de retorno de chamada para ver mais informações.
Todos os pontos de extremidade da API de Nuvem agora são compatíveis com as chamadas da versão 15.
Apenas na API de Nuvem.
Os parâmetros de texto (components.parameters.text
) em modelos de mensagem que usam somente o componente de corpo (components.type:body
) podem ter o total de 32.768 caracteres. Consulte Parameters object.
Apenas na API de Nuvem.
Agora a API de Nuvem é compatível com a combinação de até 350 (antes era 250) mensagens enviadas e recebidas por segundo (incluindo mensagens de texto e de mídia) mediante solicitação. Consulte a seção Taxa de transferência de dados para ver mais informações.
Caso você já tenha 250 mps, o limite aumentará para 350 mps automaticamente. Caso você tenha solicitado 250 mps, mas o processo não tenha sido concluído, você receberá 350 mps ao concluir.
As reações passaram a ser compatíveis. Consulte Enviar mensagens – Mensagens de reação para saber como enviar e receber reações e Payload Examples – Reaction Messages para ver exemplos de notificação com carga de webhook.
O campo about
nos perfis comerciais passou a ser compatível. Consulte o guia Business Profiles para ver mais informações.
Está disponível uma nova documentação sobre como solicitar a migração de 80 para 250 mensagens de texto e de mídia enviadas e recebidas por segundo. Consulte a seção Taxa de transferência de dados.
Agora é possível incluir figurinhas animadas em mensagens iniciadas pela empresa e receber webhooks de mensagens que descrevem essas mensagens, da mesma forma que ocorreria no envio de figurinhas comuns. Consulte a propriedade sticker
do objeto message e os requisitos para o ativo de figurinhas animadas.
Agora é possível incluir produtos e serviços nas mensagens enviadas aos clientes. Os clientes podem então adicioná-los ao carrinho de compras sem precisar sair da conversa. Saiba como enviar mensagens de produto único e de vários produtos para os clientes no guia Sell Products & Services.
Agora as empresas podem responder a qualquer mensagem em uma conversa. As respostas incluirão uma bolha contextual fazendo referência à mensagem respondida. Para saber como responder a uma mensagem, consulte o guia Enviar mensagens.
Agora a API de Nuvem é compatível com a combinação de até 250 mensagens enviadas e recebidas por segundo (incluindo mensagens de texto e de mídia) mediante solicitação. Caso você seja um parceiro empresarial, crie um tíquete no Suporte Direto solicitando a taxa de transferência de dados de 250 MPS. Para isso, selecione o assunto "Cloud API Issues" (Problemas na API de Nuvem), bem como o tipo de solicitação "Request to migrate to 250 MPS throughput" (Solicitação de migração para taxa de transferência de dados de 250 MPS) e preencha as informações necessárias.
v2.43
11 de outubro de 2022v2.43
, ocorrerão alterações no comportamento do ponto de extremidade contacts
.
status
sofrerão alterações. Independentemente de o usuário ter WhatsApp, a resposta sempre será retornada com valid
para status
e um wa_id
. Não há garantia de que o wa_id retornado será válido. Essas alterações se aplicam a respostas diretas e a respostas do webhook para chamadas sem bloqueio. status
e wa_id
retornados no nó contacts
. Além disso, na v2.39.1
e posteriores, o envio de mensagens pode ser concluído sem uma chamada para o nó contacts
. O código deve processar possíveis erros 1013
Usuário inválido, retornados ao tentar enviar um modelo de mensagem a um número de telefone sem conta do WhatsApp.
Para mensagens sem modelo, o erro 470
será retornado ao enviar uma mensagem a um número de telefone sem conta do WhatsApp.
v2.45
10 de janeiro de 2023A partir da v2.45
, o parâmetro opcional cert
do nó shards
será obrigatório para todas as solicitações. A integração deve ser atualizada para apresentar um cert
válido ao fazer chamadas para o nó shards
.
A partir da v2.41.2
, as empresas podem usar o nó application
para filtrar os status de mensagens enviadas que não forem relevantes por meio do objeto message
no objeto webhooks
. Na v2.45
, sent_status
se tornará obsoleto. Por isso, atualize sua integração para usar o objeto webhooks
no nó application
para todos os controles de webhook.
A partir da v2.39.1
, o recipient_id
está disponível nos objetos statuses
e message
. Na v2.45
, o recipient_id
será removido do objeto statuses
. Por isso, atualize sua integração para usar o recipient_id
no objeto message
.
v2.41.3
)2.41.3
A versão v2.41.3
da WhatsApp Business API do cliente inclui um novo índice de tabela em message_receipt_log
para beneficiar parceiros que precisam de altas taxas de transferência de dados de mensagens. Por exemplo, a melhoria permite que os parceiros enviem mais de 200 mensagens por segundo.
v2.41.2
)Na v2.41.2, introduzimos alterações no esquema de bancos de dados para melhorar o desempenho do sistema. Como resultado, as atualizações da v2.37.2 e v2.39.x para configurações com bancos de dados grandes (que têm milhões de entradas de mensagens e contatos) levarão mais tempo que o normal.
No geral, basta fazer as atualizações durante as horas de menor movimento, começando por configurações com baixa taxa de transferência de dados.
Para bancos de dados grandes, siga estas etapas:
Antes da atualização, execute a coleta de lixo por meio do ponto de extremidade /services/message/gc, garantindo que o processo seja bem-sucedido.
Use a ferramenta dbupgrade para atualizar os esquemas de bancos de dados antes da atualização da versão. Depois de concluir esse processo, será possível atualizar as versões da API com tempo mínimo de inatividade. Recomendamos desativar o cliente da API antes de usar a ferramenta dbupgrade. Verifique se a ferramenta dbupgrade concluiu o processo (código de saída 0). Além disso, evite ou limite as solicitações de API durante a atualização.
Recomendamos aumentar o tempo-limite de consulta nos servidores do seu banco de dados para 1 hora até o fim da atualização.
Esta versão do cliente inclui os seguintes recursos e atualizações:
delivered
e read
, fornecendo maior controle sobre as notificações de webhooks para mensagens. Isso pode ser feito por meio do ponto de extremidade settings/applications.namespace
é opcional para o objeto templateA partir de hoje, a API de Nuvem do WhatsApp Business está aberta a todos os desenvolvedores que criam produtos ou serviços para si ou para a própria organização. Para começar, consulte nosso guia. Se você tiver interesse em oferecer acesso à API aos clientes, entre na nossa lista de espera.
Os seguintes valores do parâmetro category
para o ponto de extremidade /WHATSAPP-BUSINESS-ACCOUNT-ID/message_template
ficaram obsoletos na v14.0
e posteriores:
|
|
|
Os seguintes valores foram adicionados:
TRANSACTIONAL
MARKETING
A versão do cliente inclui todos os recursos e reparos da v2.39.1
. Além disso, essa versão inclui o seguinte:
v2.39.2
.v2.39.3
.v2.39.4
, as empresas serão notificadas quando receberem uma mensagem temporária por meio de uma notificação de Webhooks com o tipo definido como "ephemeral"
. As empresas não poderão ver o conteúdo da mensagem.Quando lançamos a v2.39.3
, a questão das mensagens temporárias foi resolvida pelo WhatsApp automaticamente por meio da desabilitação dessas mensagens na conversa do bate-papo com o cliente. Na v2.39.4
, isso não será feito. Com essa versão, as empresas precisam solicitar que os clientes desabilitem as mensagens temporárias e enviem novamente a última mensagem.
2.3.8
A partir de hoje, a API de Nuvem inclui as seguintes atualizações:
2.3.7
A partir de hoje, a API de Nuvem está disponível para todos os parceiros de soluções e clientes diretos. Além disso, estamos lançando os seguintes recursos para desenvolvedores da API de Nuvem:
POST
para PHONE_NUMBER_ID/deregister
caso queira remover um número de telefone da WhatsApp Business API. Para mais informações, consulte Registro.referral
dos webhooks da API de Nuvem é diferente do referral
da API Local.Além disso, anunciamos que a análise do app não é mais obrigatória para desenvolvedores internos que usam a API de Nuvem. Todos os desenvolvedores estão sujeitos aos Limites de mensagem da Plataforma do WhatsApp Business.
Essa versão tem os mesmos recursos que a v2.37.1
, mas há uma diferença na data de validade, já que a v2.37.2
expira em 22 de setembro de 2022.
Alguns desenvolvedores Kubernetes podem ver CrashLoopBackOff
no contêiner do webapp. Isso pode causar uma falha para iniciar o contêiner. Para corrigir o problema, adicione a seguinte linha ao arquivo YML
de implantação do Kubernetes na configuração do webapp:
command: ["/opt/whatsapp/bin/wait_on_mysql.sh", "/opt/whatsapp/bin/launch_within_docker.sh"]
A partir de hoje, a versão v2.39.3
do cliente da WhatsApp Business API está disponível para os desenvolvedores. O novo cliente inclui duas correções e registros adicionais para ser compatível com a depuração. Estas são as duas correções:
A partir de hoje, os usuários beta da API de Nuvem podem começar a enviar mensagens com lista e botões de resposta. Para ver mais informações, consulte estas documentações:
A partir de hoje, os usuários beta da API de Nuvem podem adicionar uma caixa de prévia do URL a mensagens de texto com URL. Para ver mais informações, consulte estas documentações:
Acabamos de lançar a API Local v2.39.2
. Essa versão corrige o erro que impedia o envio de mensagens de vídeo em determinadas circunstâncias.
A partir de hoje, os usuários beta da API de Nuvem podem começar a enviar e receber mensagens de vídeo. As documentações a seguir fornecem mais informações:
O WhatsApp mudou o modelo de preços baseado em notificação por um modelo de preços baseado em conversa. Agora as empresas são cobradas por conversa, o que inclui todas as mensagens entregues em uma sessão de 24 horas. Consulte Preços baseados em conversa para ver mais informações.
A partir de hoje, os usuários beta da API de Nuvem podem começar a enviar e receber mensagens com localização e contato. Consulte as documentações abaixo para mais informações:
Agora aceitamos a taxa de transferência de dados em pico de 80 mensagens por número de telefone. Isso inclui o envio e o recebimento de mensagens de texto, de modelo e de mídia.
2.39.1
)A partir de hoje, a versão 2.39.1
do cliente da WhatsApp Business API está disponível para os desenvolvedores. Veja o que o novo cliente inclui:
A partir da nova versão do cliente da API, será possível fornecer o certificado do seu telefone ao configurar a multiconexão. Isso significa que, nas chamadas ao ponto de extremidade v1/account/shards, será possível adicionar o certificado codificado em Base64 no campo cert. Para mais informações, consulte Amplie seu cliente de API com a multiconexão.
Adicionamos graph.whatsapp.com
à lista de nomes de hosts de servidores com a qual a WhatsApp Business API exige conexão. Veja Configurar e depurar a rede – Nomes de host para saber mais.
A partir da versão v2.39
, adicionamos o código de erro 1031
. Você receberá esse erro caso sua conta seja bloqueada e não seja possível enviar mensagens devido a uma violação à política de integridade. Consulte Mensagens de erro e status e Monitoramento da Política para mais informações.
hsm
se tornou obsoleto na versão v2.39
. Em vez dele, será necessário usar o tipo template
.webhook_payload_conversation_pricingmodel_disabled
se tornou obsoleta.Algumas mensagens de vídeo não são enviadas em determinadas circunstâncias.