Documentation API-SMS: Solde SMS par pays

GET

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

Encodage : UTF-8

Authentification

La api-key et le api-login doivent être ajoutés dans un header.

Définition

Vous permet de récupérer votre solde SMS selon chaque destination. Le prix de chaque SMS pouvant être spécifique, il pourrait être intéressant pour vous de connaître le nombre maximum de SMS que vous pourriez envoyer vers chaque pays.

Paramètres particuliers

Nom	Type	Description
`with_details`	boolean	(optionnel) Ajoute le détail de tous les packs de votre portefeuille.
`country_code`	string	(optionnel) Code du pays dans lequel vous voulez obtenir votre solde. Vous devez également renseigner le product_name.
`product_name`	string	(optionnel) Nom du produit dans lequel vous voulez obtenir votre solde (sms_low_cost, sms_premium, vocal_sms, hlr). Vous devez également renseigner le country_code.

Exemple 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-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \

Code à copier-coller

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-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache'

Retour Server JSON

Succès : 200 OK

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