Códigos de erro

Ao interagir com a API SMSBAT, você pode encontrar erros. Usamos códigos de resposta HTTP convencionais para indicar o sucesso ou falha de uma solicitação de API.

Em geral:

• Códigos na faixa 2xx indicam sucesso.
• Os códigos na faixa 4xx indicam um erro que falhou de acordo com as informações fornecidas (por exemplo, um parâmetro obrigatório foi omitido, um tipo de mensagem é inválido, etc.).
• Códigos na faixa 5xx indicam um erro em nossos servidores.

Códigos de status HTTP

Código	Estado	Descrição
200	OK	A solicitação foi bem-sucedida.
400	Solicitação incorreta	A solicitação era inaceitável, geralmente devido à falta de um parâmetro obrigatório ou ao JSON malformado.
401	Não autorizado	Nenhuma chave de API válida foi fornecida ou a autenticação falhou.
403	Proibido	A chave de API não tem permissões para realizar a solicitação ou sua conta está suspensa.
404	Não encontrado	O recurso solicitado não existe.
415	Tipo de mídia não suportado	O cabeçalho Content-Type está ausente ou não está definido como application/json.
422	Entidade não processável	A solicitação foi formatada corretamente, mas continha erros semânticos (por exemplo, formato de número de telefone inválido).
429	Muitas solicitações	Muitas solicitações chegam à API muito rapidamente. Recomendamos uma espera exponencial de suas solicitações.
500, 502, 503, 504	Erros do servidor	Algo deu errado no final do SMSBAT.

Formato de resposta de erro

Quando uma solicitação de API resulta em erro, o corpo da resposta contém um objeto JSON com mais detalhes sobre o problema.

{
  "status": 400,
  "error": "Bad Request",
  "message": "Missing required field: 'messages'",
  "code": 1001
}

Códigos de erro de lógica de negócios (códigos internos)

Além dos códigos de status HTTP, podemos retornar um código interno específico para ajudá-lo a identificar o motivo exato da falha.

Código Interno	Descrição	Ação sugerida
1001	Formato de solicitação inválido	Certifique-se de que o corpo da sua solicitação seja JSON válido.
1002	Campo obrigatório ausente	Verifique a propriedade message na resposta para ver qual campo está faltando.
1003	Número de telefone inválido	Certifique-se de que o número do destinatário esteja no formato E.164 (por exemplo, 380501234567).
1004	Nome alfa não registrado	O parâmetro from contém um nome alfa que não foi aprovado para sua conta.
1005	Saldo insuficiente	Sua conta não possui fundos suficientes para processar a campanha de mensagens.
1006	Tipo de mensagem inválido	O parâmetro type deve ser um dos tipos suportados (por exemplo, sms, viber_promo).
1007	Modelo não encontrado	O ID do modelo Viber/OTP solicitado é inválido ou não foi aprovado.
1008	Itens inválidos do carrossel	Um Viber Carousel deve conter entre 2 e 5 itens.

[!TIP] Se você encontrar um código de erro não listado aqui ou se acreditar que um erro foi retornado por engano, entre em contato com [email protected] e forneça a carga exata da resposta e os cabeçalhos.