Inicio » API SMS Octopush » Consulta Saldo SMS por país

Consulta Saldo SMS por país

GET
https://api.octopush.com/v1/public/wallet/check-balance

Codificación : UTF-8

Autentificación

Su “api-key” y “api-login” deben ser añadidos en las cabeceras.

Definición

Permite recuperar el saldo de los SMS por país de destino. Debido a que el precio de cada SMS puede cambiar según el destino, puede ser interesante conocer el número máximo de SMS que puedes enviar a cada país.

Parámetros especiales

CampoTipoDescripción
with_detailsboolean(opcional) Añade los detalles de todos los paquetes de su billetera.
country_codestring(opcional) Código del país en el que desea obtener su saldo. También debe rellenar el nombre del producto (product_name)
product_namestring(opcional) Nombre del producto en el que desea obtener su saldo (sms_low_cost, sms_premium, vocal_sms, hlr). También debe rellenar el código de país (country_code)

Ejemplo Curl

curl -X GET \ 
'https://api.octopush.com/v1/public/wallet/check-balance?country_code=FR&product_name=sms_premium&with_details=true' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \
-d  '
{
  "country_code": "FR",
  "product_name": "sms_premium",
  "with_details": true
}'

Respuesta Servidor JSON

Success : 201 OK

{
  "amount": 204,
  "unit": "sms_premium", 
  "wallet_packs": 
  [
    {
      "id": "bacf3d83-1524-13eb-a5e2-0242af120002",
      "credit": 12.54,
      "expiration_date": "2030-10-23T13:41:46+02:00" 
    }
  ]
}