Consultar Créditos
Consulta el saldo de créditos disponible en la cuenta.
Si la cuenta es administradora (incluidas las de marca blanca), la respuesta incluye
además master_credit: los créditos disponibles para asignar a subcuentas,
distintos del saldo propio de envío (credit). En cuentas normales y en subcuentas
esa propiedad no aparece, así que verifica su presencia antes de leerla.
post
/credits/consultEl campo credit de la respuesta es el saldo disponible de la cuenta, no los créditos consumidos.
Antes de un envío grande, consulta el saldo para no fallar a mitad de la campaña con sms_07 (créditos insuficientes).
Respuesta
200Saldo de créditos
successboolean
messagestring
Mensaje de estado
statusinteger
codestring
Código de respuesta
creditstring
Créditos disponibles. Viaja como cadena decimal (columna
numeric(10,2)), no como número JSON: conviértela antes de operar con ella.master_creditstring | null
Créditos disponibles para asignar a subcuentas, distintos del saldo propio de envío (
credit). Presente únicamente en cuentas administradoras (incluidas las de marca blanca). En cuentas normales y en subcuentas la propiedad no aparece en la respuesta: verifica su presencia antes de leerla, no asumas que llega en 0. Puede venir en null en el caso límite de una cuenta administradora cuya bolsa nunca fue inicializada.400Error de validación.
successboolean
Siempre false para respuestas de error
messagestring
Descripción del error en español
statusinteger
Campo legado dentro del cuerpo. Conserva su valor histórico (normalmente 200) y NO coincide con el status HTTP real: la respuesta puede llegar con HTTP 400/402/404/409/502 mientras este campo sigue en su valor legado. Usa el status HTTP de transporte y el
code, no este campo.codestring
Código de error estructurado ({dominio}_{número}). Identifica de forma única la causa del error para manejo programático.
401No autorizado: API Key no provista, inválida o expirada
successboolean
Siempre false
messagestring
Descripción del error de autenticación en español
statusinteger
Campo legado en el cuerpo. Es el status HTTP de transporte; para autenticación coincide con el status real (401). Usa el status HTTP y el code, no este campo.
codestring
Código de error de autenticación (auth_01, auth_03, auth_05)
403Prohibido: La dirección IP no está autorizada para acceder (IP whitelist)
successboolean
Siempre false
messagestring
Descripción del error
statusinteger
Campo legado en el cuerpo. Puede NO coincidir con el status HTTP real: para auth_06 y auth_07 este campo vale 401 (valor histórico congelado) mientras el status HTTP de transporte es 403. Usa el status HTTP y el code, no este campo.
codestring
Código de error: auth_04 (IP no autorizada), auth_06 (cuenta deshabilitada), auth_07 (admin inválido)
429Demasiadas peticiones: Límite de rate limit excedido (100 mensajes/segundo producción, 100 envíos de prueba por día en sandbox)
successboolean
Siempre false
messagestring
Descripción del error
statusinteger
Código HTTP
codestring
Código de error de rate limit
500Error interno del servidor
successboolean
Siempre false
messagestring
Descripción del error
statusinteger
Campo legado dentro del cuerpo. Conserva su valor histórico (p.ej. 200 o 401 según el endpoint) y NO coincide con el status HTTP real (500). Usa el status HTTP de transporte y el
code, no este campo.codestring
Código de error interno (p.ej. server_01, o auth_99 en un error interno de autenticación)
request_idstring· uuid
Identificador único de la petición. Inclúyelo al contactar a soporte.