Consultar saldo

Si necesitas obtener en tiempo real el saldo disponible de tu cuenta de SMS de EngageLab, puedes llamar a esta interfaz. La interfaz devuelve el saldo normal, el saldo de regalo y el saldo total de tu cuenta.

Dirección de la llamada

GET https://smsapi.engagelab.com/v1/balance

Verificación de la llamada

Consulta Verificación de la llamada para saber cómo autenticar las solicitudes a la API.

Ejemplo de solicitud

Cabecera de la solicitud

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Este bloque de código se muestra en una ventana flotante

Cuerpo de la solicitud

Ninguno

Parámetros de solicitud

Ninguno

Parámetros de respuesta

Respuesta correcta

El código de estado HTTP es 200 y el cuerpo de la respuesta contiene los siguientes campos:

Campo	Tipo	Opción	Descripción
balance10000	Integer	Sí	Saldo normal, valor entero multiplicado por 10000
gift_balance10000	Integer	Sí	Saldo de regalo, valor entero multiplicado por 10000
balance	Number	Sí	Saldo normal, en coma flotante
gift_balance	Number	Sí	Saldo de regalo, en coma flotante
total_balance10000	Integer	Sí	Saldo total, igual a la suma del saldo normal y el saldo de regalo, valor entero multiplicado por 10000
total_balance	Number	Sí	Saldo total, igual a la suma del saldo normal y el saldo de regalo, en coma flotante

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

Este bloque de código se muestra en una ventana flotante

Recomendación de desarrollo Se recomienda que la parte que realiza la llamada utilice preferentemente los campos balance10000, gift_balance10000 y total_balance10000 para formatear el saldo por su cuenta y así evitar problemas de precisión de coma flotante.

Respuesta de error

El código de estado HTTP es 4xx o 5xx y el cuerpo de la respuesta contiene los siguientes campos:

Campo	Tipo	Opción	Descripción
code	Integer	Sí	Código de error, consulta la descripción de los códigos de error
message	String	Sí	Detalle del error

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

Este bloque de código se muestra en una ventana flotante

Códigos de error

Código de error	http code	Descripción
1000	500	Error interno, vuelve a intentarlo más tarde
2001	401	Error de autenticación: no se incluyó un token correcto, o el comercio asociado al token no existe
2002	401	Error de autenticación: el token ha caducado o ha sido deshabilitado
2002	403	El comercio ha sido eliminado