Consulter le solde

Si vous avez besoin de connaître en temps réel le solde disponible de votre compte SMS EngageLab, vous pouvez appeler cette interface. Elle retourne le solde ordinaire, le solde offert ainsi que le solde total de votre compte.

URL d'appel

GET https://smsapi.engagelab.com/v1/balance

Authentification des appels

Veuillez consulter Authentification des appels pour savoir comment authentifier vos requêtes API.

Exemple de requête

En-tête de requête

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Afficher ce bloc de code dans la fenêtre flottante

Corps de requête

Aucun

Paramètres de requête

Aucun

Paramètres de réponse

Réponse en cas de succès

Le code de statut HTTP est 200 et le corps de la réponse contient les champs suivants :

Champ	Type	Option	Description
balance10000	Integer	Obligatoire	Solde ordinaire, valeur entière multipliée par 10000
gift_balance10000	Integer	Obligatoire	Solde offert, valeur entière multipliée par 10000
balance	Number	Obligatoire	Solde ordinaire, nombre à virgule flottante
gift_balance	Number	Obligatoire	Solde offert, nombre à virgule flottante
total_balance10000	Integer	Obligatoire	Solde total, égal à la somme du solde ordinaire et du solde offert, valeur entière multipliée par 10000
total_balance	Number	Obligatoire	Solde total, égal à la somme du solde ordinaire et du solde offert, nombre à virgule flottante

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

Afficher ce bloc de code dans la fenêtre flottante

Conseil de développement Il est recommandé aux appelants d'utiliser en priorité les champs balance10000, gift_balance10000 et total_balance10000 pour formater eux-mêmes le solde, afin d'éviter les problèmes de précision liés aux nombres à virgule flottante.

Réponse en cas d'échec

Le code de statut HTTP est 4xx ou 5xx et le corps de la réponse contient les champs suivants :

Champ	Type	Option	Description
code	Integer	Obligatoire	Code d'erreur, voir la description des codes d'erreur
message	String	Obligatoire	Détail de l'erreur

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code d'erreur	http code	Description
1000	500	Erreur interne, veuillez réessayer ultérieurement
2001	401	Échec de l'authentification : token incorrect ou marchand correspondant au token inexistant
2002	401	Échec de l'authentification : token expiré ou désactivé
2002	403	Le marchand a été supprimé