Documentation API-SMS: Consultation des crédits

GET

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

Encodage : UTF-8

Authentification

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

Définition

Ce Web Service vous permet de récupérer la quantité de crédits par produit, selon les pays choisis.

Le résultat est une liste, pays par pays, des crédits pour chaque type de produit (SMS Premium, SMS Vocal, HRL, etc…

Paramètres particuliers

Nom	Type	Description
`country_codes[]`	string[]	(optionnel) La liste des pays pour lesquels vous souhaitez obtenir le nombre de crédits par produit.

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'

Server Retour JSON

Succès : 200 OK

{
   "DE" : {
     "premium_sms": 5,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   },
   "FR": {
     "premium_sms": 10,
     "vocal_sms": 0,
     "low_cost_sms": 21,
     "hlr": 87
   },
   "GB": {
     "premium_sms": 5,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   },
   "??": {"..."},
   "??": {"..."},
   "??": {"..."},
   "ES": {
     "premium_sms": 6,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   },
   "IT": {
     "premium_sms": 8,
     "vocal_sms": 0,
     "low_cost_sms": 0,
     "hlr": 87
   }
 }