Tratando Erros da API da ZapMe

Introdução

Se você leu a página anterior por completo, você deve ter observado que todas as respostas da API retornam sempre dois índices: status e result, por exemplo:

{
  "status": true,
  "result": "message_sent",
  "date": "2025-06-06 14:04:06",
  "data": "mensagem enviada"
}

date é a data e a hora do envio da resposta, em formato: Y-m-d H:i:s.

Esses índices são fundamentais para entender o resultado de uma requisição e, principalmente, para tratar erros de forma adequada. Nesta página iremos explorar como interpretar os índices retornados pelas respostas da API e o que cada um deles significa.

Status de Resposta

Quando status for diferente de true, ou seja: false, significa que houve algum erro na requisição. Utilize o campo result da resposta para identificar o tipo de erro ocorrido. Por exemplo:

{
  "status": false,
  "result": "invalid_credential",
  "date": "2025-06-06 14:52:14",
  "error": [
    "credenciais invalidas"
  ]
}

Neste caso, o índice result indica que as credenciais fornecidas são inválidas, e o índice error fornece uma descrição do erro em formato de array, que pode conter uma ou mais mensagens de erro.

Indices de Resposta

Quando result for:	Significa que:
invalid_credential	As credenciais de API informadas estão inválidas.
unauthorized	Seu plano de serviço não está ativo na plataforma da ZapMe.
unauthorized_ip	O seu IP não está permitido a se conectar com a API.
authentication_not_found	Seu WhatsApp não está autenticado na plataforma da ZapMe.
validation_error	Houve um erro de validação da requisição.
not_found	Você tentou recuperar algo que não foi encontrado.
limit_reached	Você atingiu o limite do recurso.