Códigos de error

Al interactuar con la API SMSBAT, puede encontrar errores. Utilizamos códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API.

En general:

• Los códigos en el rango 2xx indican éxito.
• Los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido, un tipo de mensaje no es válido, etc.).
• Los códigos en el rango 5xx indican un error con nuestros servidores.

Códigos de estado HTTP

Código	Estado	Descripción
200	OK	La solicitud fue exitosa.
400	Solicitud incorrecta	La solicitud era inaceptable, a menudo debido a que faltaba un parámetro requerido o JSON con formato incorrecto.
401	No autorizado	No se proporcionó ninguna clave API válida o falló la autenticación.
403	Prohibido	La clave API no tiene permisos para realizar la solicitud o su cuenta está suspendida.
404	No encontrado	El recurso solicitado no existe.
415	Tipo de medio no admitido	Falta el encabezado “Content-Type” o no está configurado en “application/json”.
422	Entidad no procesable	La solicitud tenía el formato correcto pero contenía errores semánticos (por ejemplo, formato de número de teléfono no válido).
429	Demasiadas solicitudes	Demasiadas solicitudes llegan a la API demasiado rápido. Recomendamos un retroceso exponencial de sus solicitudes.
500, 502, 503, 504	Errores del servidor	Algo salió mal al final de SMSBAT.

Formato de respuesta de error

Cuando una solicitud de API genera un error, el cuerpo de la respuesta contiene un objeto JSON con más detalles sobre el problema.

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

Códigos de error de lógica empresarial (códigos internos)

Además de los códigos de estado HTTP, podemos devolver un “código” interno específico para ayudarle a identificar el motivo exacto del error.

Código Interno	Descripción	Acción sugerida
1001	Formato de solicitud no válido	Asegúrese de que el cuerpo de su solicitud sea JSON válido.
1002	Falta el campo obligatorio	Verifique la propiedad “mensaje” en la respuesta para ver qué campo falta.
1003	Número de teléfono no válido	Asegúrese de que el número del destinatario esté en formato E.164 (por ejemplo, 380501234567).
1004	Nombre Alfa no registrado	El parámetro “de” contiene un nombre alfa que no ha sido aprobado para su cuenta.
1005	Saldo insuficiente	Su cuenta no tiene fondos suficientes para procesar la campaña de mensajería.
1006	Tipo de mensaje no válido	El parámetro type debe ser uno de los tipos admitidos (por ejemplo, sms, viber_promo).
1007	Plantilla no encontrada	El ID de la plantilla de Viber/OTP solicitada no es válido o no está aprobado.
1008	Elementos del carrusel no válidos	Un Viber Carousel debe contener entre 2 y 5 elementos.

[!CONSEJO] Si encuentra un código de error que no figura aquí, o si cree que se devolvió un error por error, comuníquese con [email protected] y proporcione la carga útil y los encabezados de respuesta exactos.