A API de Nuvem é desenvolvida na Graph API. Por isso, caso você não tenha familiaridade com o tratamento de respostas de erro da Graph API, consulte a documentação Como solucionar erros.
Em geral, recomendamos desenvolver a lógica de tratamento de erros do app em torno de valores code
e propriedades da carga details
. Essas propriedades e valores são um indicador mais confiável do erro subjacente.
Os títulos de código, que não têm uma propriedade dedicada nas cargas de respostas de erro de API, são incluídos como parte do valor message
. No entanto, não recomendamos que você dependa deles na lógica de tratamento de erros, pois eles podem estar obsoletos.
Os erros da API de Nuvem são retornados como resposta da Graph API de modo síncrono, via Webhook de forma assíncrona ou pelos dois métodos.
Se você usar a API de Nuvem, recomendamos monitorar tanto a resposta da Graph API quanto o webhook messages
para a solução de erros. Se tiver assinado o campo messages
de webhooks, você receberá notificações dos tipos de erros assíncronos compatíveis quando eles ocorrerem.
Os erros da API de Nuvem podem aparecer nos seguintes objetos de webhook:
API de Nuvem
entry.changes.value.errors
entry.changes.value.messages.errors
API Local
errors
Sintaxe de resposta a erros
{ "error": { "message": "<MESSAGE>", "type": "<TYPE>", "code": <CODE>, "error_data": { "messaging_product": "whatsapp", "details": "<DETAILS>" }, "error_subcode": <ERROR_SUBCODE> "fbtrace_id": "<FBTRACE_ID>" } }
Propriedade | Tipo de valor | Descrição |
---|---|---|
| Número inteiro | Código de erro. Recomendamos desenvolver o tratamento de erros do app em torno de códigos de erro em vez de subcódigos ou códigos de status da resposta HTTP. |
| String | Descrição do erro e do motivo mais provável. Também pode conter informações sobre como resolver o erro. Por exemplo, qual parâmetro é inválido ou quais valores são aceitáveis. |
| Número inteiro | Obsoleto. Não será retornado em respostas da versão 16.0 ou posteriores. O subcódigo da Graph API. Nem todas as respostas incluirão um subcódigo. Por isso, recomendamos que você desenvolva a própria lógica de tratamento de erros em relação ao valor |
| String | Identificação de rastreamento que você pode incluir ao entrar em contato com o Suporte Direto. A identificação pode nos ajudar a depurar o erro. |
| String | Combinação do código de erro e do título. Por exemplo: |
| String | Produto de mensagens. Será sempre a string |
| String | Tipo de erro. |
{ "error": { "message": "(#130429) Rate limit hit", "type": "OAuthException", "code": 130429, "error_data": { "messaging_product": "whatsapp", "details": "Message failed to send because there were too many messages sent from this phone number in a short period of time" }, "error_subcode": 2494055, "fbtrace_id": "Az8or2yhqkZfEZ-_4Qn_Bam" } }
Código | Descrição | Soluções possíveis | Código de status HTTP |
---|---|---|---|
AuthException | Não foi possível autenticar o usuário do app. | Geralmente, isso significa que o token de acesso incluído expirou, foi invalidado ou que o usuário do app alterou uma configuração para impedir que todos os apps acessem os dados dele. Recomendamos que você obtenha um novo token de acesso. |
Não autorizado |
Método de API | Indica um problema que envolve recursos ou permissões. | Use o depurador de token de acesso para verificar se as permissões necessárias foram concedidas ao seu app pelo ponto de extremidade. Consulte Solução de problemas. |
Erro interno do servidor |
Permissão negada | A permissão não foi concedida ou foi removida. | Use o depurador de token de acesso para verificar se as permissões necessárias foram concedidas ao seu app pelo ponto de extremidade. Consulte Solução de problemas. Verifique se o número de telefone usado para definir a chave pública de empresa está na lista de permissões. |
Proibido |
O token de acesso expirou | O token de acesso expirou. |
Não autorizado | |
Permissão da API | A permissão não foi concedida ou foi removida. | Use o depurador de token de acesso para verificar se as permissões necessárias foram concedidas ao seu app pelo ponto de extremidade. Consulte Solução de problemas. |
Proibido |
Código | Descrição | Soluções possíveis | Código de status HTTP |
---|---|---|---|
Muitas chamadas de API | O app atingiu o limite da taxa de chamadas de API. | Carregue o app no Painel de Apps e veja a seção Limite de volume do app para conferir se o limite de volume foi atingido. Em caso afirmativo, tente novamente mais tarde ou reduza a frequência ou a quantidade de consultas da API que o app está fazendo. |
Solicitação incorreta |
Problemas com limite de volume | A conta do WhatsApp Business atingiu o limite de volume. | Consulte os Limites de volume da conta do WhatsApp Business. Tente novamente mais tarde ou reduza a frequência ou a quantidade de consultas da API que o app está fazendo. |
Solicitação incorreta |
Limite de volume atingido | A taxa de transferência de dados de mensagens da API de Nuvem foi atingida. | O app atingiu o limite da taxa de transferência de dados da API. Consulte Taxa de transferência de dados. Tente novamente mais tarde ou reduza a frequência com que o app envia mensagens. |
Solicitação incorreta |
Limite de taxa de spam atingido | Falha ao enviar a mensagem devido a um limite de envios que podem ser feitos deste número de telefone. É possível que muitas mensagens anteriores tenham sido bloqueadas ou marcadas como spam. | Verifique seu status de qualidade no Gerenciador do WhatsApp e consulte a documentação Limites de mensagem: Classificação de qualidade para saber mais. |
Solicitação incorreta |
Limite de volume de emparelhamento atingido (conta comercial, conta de consumidor) | Foram enviadas muitas mensagens do número de telefone do remetente para o mesmo número de telefone do destinatário em um curto período. | Aguarde e realize novamente a operação se quiser enviar mensagens para o mesmo número de telefone. Você ainda pode enviar mensagens para um número diferente sem esperar. |
Solicitação incorreta |
Limite de taxa de registro/exclusão de contas excedido | O registro ou a exclusão do registro falhou porque foram feitas muitas tentativas neste número de telefone em um curto período de tempo. | O número de telefone comercial está sendo bloqueado porque atingiu o limite de tentativas de registro/cancelamento do registro. Tente novamente assim que o número for desbloqueado. Consulte a seção "Limitações" no documento Registro. |
Solicitação incorreta |
Código | Descrição | Soluções possíveis | Código de status HTTP |
---|---|---|---|
Bloqueado temporariamente por violações de políticas | A conta do WhatsApp Business associada ao app foi restringida ou desabilitada por violar uma política da plataforma. | Consulte a documentação Monitoramento da Política da Plataforma do WhatsApp Business e Spam para saber mais sobre as violações das políticas e como solucioná-las. |
Proibido |
A conta comercial está impedida de enviar mensagens a usuários neste país. | A conta do WhatsApp Business está impedida de enviar mensagens para usuários em determinados países. | Consulte a Política de Mensagens do WhatsApp Business para descobrir quais países são compatíveis com o envio de mensagens na categoria da sua empresa. |
Proibido |
Conta bloqueada | A conta do WhatsApp Business associada ao app foi restringida ou desabilitada por violar uma política da plataforma. Ou então, não foi possível verificar os dados incluídos na solicitação em relação ao conjunto de dados na conta do WhatsApp Business (por exemplo, o pin de duas etapas incluído na solicitação está incorreto). | Consulte a documentação Monitoramento da Política da Plataforma do WhatsApp Business e Spam para saber mais sobre as violações das políticas e como solucioná-las. Você também pode usar a API de Status de Integridade, que pode fornecer informações adicionais sobre o(s) motivo(s) para o bloqueio da conta. |
Proibido |
Código | Descrição | Soluções possíveis | Código de status HTTP |
---|---|---|---|
API desconhecida | Solicitação inválida ou possível erro do servidor. | Consulte a página WhatsApp Business API Status para ver as informações de status da API. Se não houver interrupções no servidor, consulte a referência do ponto de extremidade para verificar se a solicitação está formatada corretamente e atende a todos os requisitos necessários. |
Solicitação incorreta |
Serviço de API | Há um erro temporário por inatividade ou sobrecarga. | Antes de tentar de novo, consulte a página WhatsApp Business API Status para ver as informações de status da API. |
Serviço indisponível |
O valor do parâmetro é inválido | O número de telefone comercial foi excluído. | Verifique se o número de telefone comercial está correto. |
Solicitação incorreta |
Parâmetro inválido | O pedido incluía um ou mais parâmetros incompatíveis ou escritos de forma errada. | Consulte a referência do ponto de extremidade para determinar quais parâmetros são compatíveis e como são escritos. Ao configurar a chave pública de empresa, verifique se ela é uma chave pública RSA válida de 2.048 bits no formato PEM. Verifique se não há incompatibilidade entre a identificação do número de telefone que você está registrando e outra armazenada anteriormente. Assegure-se de que o parâmetro atende às restrições de tamanho para o tipo. |
Solicitação incorreta |
O número do usuário faz parte de um experimento | A mensagem não foi enviada como parte de um experimento. |
Solicitação incorreta | |
Ocorreu um erro | Falha ao enviar a mensagem devido a um erro desconhecido. Ao definir a chave pública da empresa, houve uma falha ao calcular a assinatura, fazer uma chamada ao ponto de extremidade do GraphQL, ou o ponto de extremidade do GraphQL retornou um erro. | Tente novamente. Se o erro persistir, abra um tíquete de Suporte Direto. |
Erro interno do servidor |
Acesso negado | A permissão não foi concedida ou foi removida. | Use o depurador de token de acesso para verificar se as permissões necessárias foram concedidas ao seu app pelo ponto de extremidade. Consulte Solução de problemas. |
Proibido |
Parâmetro obrigatório ausente | Falta um parâmetro obrigatório no pedido. | Consulte a referência do ponto de extremidade para determinar quais parâmetros são obrigatórios. |
Solicitação incorreta |
O valor do parâmetro é inválido | Um ou mais valores de parâmetros são inválidos. | Consulte a referência do ponto de extremidade para determinar quais valores são compatíveis com cada parâmetro. Veja a documentação Números de telefone para saber como adicionar um número a uma conta do WhatsApp Business. |
Solicitação incorreta |
Serviço indisponível | Um serviço está temporariamente indisponível. | Antes de tentar de novo, consulte a página WhatsApp Business API Status para ver as informações de status da API. |
Erro interno do servidor |
O destinatário não pode ser o remetente | O número de telefone do destinatário e do remetente é o mesmo. | Envie uma mensagem para um número de telefone diferente daquele do remetente. |
Solicitação incorreta |
A mensagem não pode ser entregue | Não foi possível entregar a mensagem. Os motivos podem ser os seguintes:
| Usando um método de comunicação diferente do WhatsApp, peça ao usuário do WhatsApp para:
|
Solicitação incorreta |
Elegibilidade da empresa – Problema com pagamento | Ocorreu um erro relacionado à forma de pagamento. | Consulte Sobre a cobrança da sua conta do WhatsApp Business e verifique se a faturação está configurada corretamente. Problemas comuns:
|
Solicitação incorreta |
Certificado incorreto | Ocorreu uma falha ao enviar a mensagem devido a um erro de registro do número de telefone. | Registre o número de telefone antes de tentar novamente. |
Erro interno do servidor |
Mensagem de novo envolvimento | Mais de 24 horas se passaram desde que o destinatário respondeu pela última vez ao número do remetente. | Envie uma mensagem iniciada pela empresa usando um modelo de mensagem. |
Solicitação incorreta |
A Meta escolheu não entregar a mensagem | para manter o engajamento saudável do ecossistema. | Ao receber este código de erro, não tente enviar a mensagem de novo imediatamente se suspeitar que o problema é relacionado ao limite. Em vez disso, tente novamente aplicando incrementos de tempo maiores até que a mensagem seja entregue, já que o limite talvez esteja em vigor por diferentes períodos. ConsulteLimites de mensagem de modelo de marketing por usuário para saber mais. |
Solicitação incorreta |
Tipo de mensagem não compatível | O tipo de mensagem não é compatível. | Consulte Mensagens para ver os tipos de mensagem compatíveis antes de tentar novamente. |
Solicitação incorreta |
Erro de download de mídia | Não foi possível baixar a mídia enviada pelo usuário. | Não foi possível baixar mídias incluídas na mensagem do usuário do WhatsApp. Para obter mais informações, consulte o valor Peça ao usuário do WhatsApp para enviar o arquivo de mídia usando um método que não seja o WhatsApp. |
Solicitação incorreta |
Erro de carregamento de mídia | Não foi possível carregar a mídia usada na mensagem. | Não foi possível carregar a mídia por um ou mais motivos, por exemplo, um tipo de mídia não compatível. Para obter mais informações, consulte o valor Recomendamos que você inspecione os arquivos de mídia que estão causando erros e confirme se eles são realmente compatíveis. Por exemplo, no UNIX, é possível usar a inspeção de arquivos por meio da linha de comando para determinar seu tipo MIME:
Você pode então confirmar se o seu tipo MIME é compatível. Consulte Supported Media Types. |
Solicitação incorreta |
Conta em modo de manutenção | A conta comercial está em modo de manutenção. | A conta do WhatsApp Business está em modo de manutenção. Talvez a conta esteja passando por uma atualização da taxa de transferência de dados. |
Solicitação incorreta |
Incompatibilidade na contagem de parâmetros do modelo | O número de valores de parâmetros variáveis incluídos na solicitação não corresponde ao número de parâmetros variáveis definidos no modelo. | Consulte Diretrizes para modelos de mensagem e garanta que a solicitação inclua todos os valores de parâmetro variável definidos no modelo. |
Solicitação incorreta |
Modelo não existe | O modelo não existe no idioma especificado ou não foi aprovado. | Verifique se o modelo foi aprovado e se o nome do modelo e a localidade do idioma estão corretos. Siga as diretrizes para modelos de mensagem. |
Não encontrado |
Texto hidratado do modelo longo demais | O texto traduzido é longo demais. | Consulte o Gerenciador do WhatsApp para verificar se o seu modelo foi traduzido. Consulte Classificação de qualidade e status do modelo. |
Solicitação incorreta |
Política de caracteres do formato do modelo violada | O conteúdo do modelo viola uma política do WhatsApp. | Consulte Razões de rejeição para determinar os possíveis motivos para violação. |
Solicitação incorreta |
Incompatibilidade no formato do parâmetro do modelo | Os valores de parâmetros variáveis foram formatados incorretamente. | Os valores de parâmetros variáveis incluídos na solicitação não estão usando o formato especificado no modelo. Consulte Diretrizes de modelos de mensagem. |
Solicitação incorreta |
Modelo pausado | O modelo foi pausado por baixa qualidade e não pode ser enviado em mensagens. | Edite o modelo para melhorar a qualidade e tente novamente após a aprovação. |
Solicitação incorreta |
Modelo desabilitado | O modelo foi pausado muitas vezes por baixa qualidade e foi desabilitado de forma permanente. | Crie um modelo novo com conteúdo diferente. |
Solicitação incorreta |
Fluxo bloqueado | O fluxo está no estado bloqueado. | Corrija o fluxo. |
Solicitação incorreta |
Fluxo limitado | O fluxo está no estado limitado, e 10 mensagens usando esse fluxo já foram enviadas na última hora. | Corrija o fluxo. |
Solicitação incorreta |
Cancelamento do registro incompleto | Uma tentativa anterior de cancelamento do registro falhou. | Cancele o registro do número novamente antes de registrá-lo. |
Erro interno do servidor |
Servidor temporariamente indisponível | O servidor está temporariamente indisponível. | Antes de tentar de novo, consulte a página WhatsApp Business API Status para ver as informações de status da API e verifique o valor |
Serviço indisponível |
Incompatibilidade do PIN na confirmação em duas etapas | O PIN de confirmação em duas etapas está incorreto. | Verifique se o PIN incluído na solicitação está correto. Para redefinir o PIN de confirmação em duas etapas:
|
Solicitação incorreta |
Reverificação do número de telefone necessária | O número de telefone precisa ser verificado antes do registro. | Verifique o número de telefone antes de registrá-lo. |
Solicitação incorreta |
Muitas tentativas do PIN de confirmação em duas etapas | Ocorreram muitas tentativas do PIN de confirmação em duas etapas para este número de telefone. | Tente novamente após o período especificado no valor de resposta |
Solicitação incorreta |
Tentativa muito rápida do PIN de confirmação em duas etapas | O PIN de confirmação em duas etapas foi inserido muito rapidamente. | Consulte o valor da resposta |
Solicitação incorreta |
Número de telefone não registrado | O número de telefone não está registrado na Plataforma do WhatsApp Business. | Registre o número de telefone antes de tentar novamente. |
Solicitação incorreta |
Aguarde alguns minutos antes de tentar registrar este número de telefone | O número de telefone que você está tentando registrar foi excluído recentemente, e a exclusão ainda não foi concluída. | Espere 5 minutos antes de tentar novamente. |
Solicitação incorreta |
Erro genérico do usuário | Falha ao enviar a mensagem devido a um erro desconhecido com seus parâmetros de solicitação. | Consulte a referência do ponto de extremidade para determinar se a consulta ao ponto de extremidade está sendo feita com a sintaxe correta. Entre em contato com o suporte ao cliente se continuar a receber esse erro na resposta. |
Solicitação incorreta |