Documentation API-SMS: Consultation du Solde SMS

GET

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

Encodage : UTF-8

Authentification

Vos identifiants « api-key » et « api-login » doivent être ajoutés dans les headers.

Vous pouvez également utiliser Basic Auth.

Définition

Ce Web Service vous permet de récupérer votre solde en SMS.
Le résultat vous donne votre solde en Premium et en LowCost.

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' \ 
-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' -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": 12.54,
  "unit": "euros"
}