Status de Retorno

Para auxiliar no tratamento de erros retornados pela API criamos a sintaxe status_result, que consiste em uma abreviatura do resultado da requisição, ajudando o usuário a entender prováveis causas do erro da requisição. Veja abaixo uma lista com todos os status_result disponíveis para entender o significado de cada um deles.

Lista dos Status de Retorno

• nothing_to_do

Erro de parâmetros fundamentais

• inexistent_method

Método informado inexistente/inválido

• validation_failure

Falha de validação de parâmetros ou de recursos para uso da API

• qr_code_unauthenticated

QR Code não autenticado para envio de mensagem - método: sendmessage

• phone_in_use

Telefone informado já encontra-se em uso na agenda - método: addcontact

• maximum_contacts

Quantidade máxima de contatos na agenda foi atingida - método: addcontact

• group_non_exist

Grupo informado não existe na agenda - método: addcontact

• contact_created

Contato criado com sucesso - método: addcontact

• limit_reached

Envio abortado por excesso de limite definido - método: sendmessage

• ignore_out_of_expedient

Envio abortado por configuração de abortar envio no horário de expediente - método: sendmessage

• document_error

Envio abortado por erro no arquivo anexado - método: sendmessage

• message_queued

Envio efetuado com sucesso. Mensagem em fila - método: sendmessage

• message_not_found

Id de mensagem não encontrada - método: consultmessage

• consulted_successfully

Consulta de mensagem retornada com sucesso - método: consultmessage

• listed_successfully

Consulta de lista de mensagens retornada com sucesso - método: listmessages

• qrcode_requesterror

Erro na requisição do QR Code - método: requestqrcode (reporte ao suporte)

• qrcode_noqrcode

API sem QR Code definido para ser expirado - método: expireqrcode

Aviso

O status_result é retornado em todas as requisições da API. Desta forma você pode consulta-lo aqui para entender a razão de um suposto problema ou “má comportamento da API”.