Documentation API-SMS: Crédits par pays

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 consulter la quantité de crédits (envoi unitaire) que vous avez pour chaque type de service / produit que nous proposons, et pour les pays que vous indiquerez dans la requête.

Paramètres particuliers

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

Exemple Curl

curl -X GET \ 
'https://api.octopush.com/v1/public/wallet/check-credits?country_codes[]=FR&country_codes[]=ES&country_codes[]=GB' \ 
-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-credits?country_codes[]=FR&country_codes[]=ES&country_codes[]=GB' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache'

Retour Server en json

Succès : 200 OK

{
   "ES" : {
     "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
   }
 }