Tratamento & Depuração de Erros

Introdução

Ao emitir uma requisição para a API da ZapMe, independente do método utilizado, uma série de validações será aplicada afim de verificar se todos os requisitos necessários atendem as expectativas. Se você perceber que a requisição retornou com o status como false, o result irá conter um identificador do tipo do erro e haverá uma chave chamada: error correspondendo a um array com descrições sobre o erro. De modo geral, podemos considerar que a chave result do retorno da API serve específicamente para facilitar o entendimento sobre o resultado da requisição.

Dica

Usando o pacote SDK PHP você pode ter certeza que a requisição retornou com sucesso consultando se o status retornou como: true. Realizando requisições manualmente para a API da ZapMe você pode ter certeza que a requisição retornou com sucesso consultando se o “status code” da resposta retornou: 200 ou 201 e o status retornou como: true.

Detalhamento de Erros

Quando o result for invalid_credential significa que:

  • As credenciais de API informadas estão inválidas.

Quando o result for unauthorized significa que:

  • Seu plano de serviço não está classificado como ativo na plataforma da ZapMe.

Quando o result for unauthorized_ip significa que:

  • A configuração de controle da API sobre os IPs autorizados a se conectarem com as credenciais da API está habilitada, mas o seu endereço de IP não está entre um dos permitidos.

Quando o result for authentication_not_found significa que:

  • Você tentou emitir o envio de uma mensagem sem estar com o WhatsApp autenticado na plataforma.

Quando o result for validation_error significa que:

  • Houve um erro de validação sobre os dados enviados na requisição.

Dica

Você terá a descrição dos erros em uma chave chamada: error, contendo um array com os erros, onde cada chave do array refere-se ao nome do parâmetro que está com erro.

Quando o result for not_found significa que:

  • Você tentou recuperar algo que não foi encontrado na plataforma ou não pertence a sua conta de usuário através das credenciais de API informadas.

Quando o result for limit_reached significa que:

  • Você tentou criar um contato, porém a sua quantidade de contatos está no limite estabelecido como padrão ou vinculado a sua conta.

Aviso

Se você perceber que a sua requisição retornou como um erro, mas o result não está entre um dos mencionados acima: reporte o ocorrido ao suporte da ZapMe para que possamos identificar o result e adicioná-lo a esta página.