Guthaben abfragen

Wenn Sie das verfügbare Guthaben Ihres EngageLab SMS-Kontos in Echtzeit abrufen möchten, können Sie diese API aufrufen. Sie gibt das allgemeine Guthaben, das Bonus-Guthaben und das Gesamtguthaben Ihres Kontos zurück.

Anfrage-URL

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

Aufruf-Authentifizierung

Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.

Anfragebeispiel

Anfrage-Header

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

Keiner

Anfrageparameter

Keine

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext enthält die folgenden Felder:

Feld	Typ	Option	Beschreibung
balance10000	Integer	Erforderlich	Allgemeines Guthaben, ein Ganzzahlwert multipliziert mit 10000
gift_balance10000	Integer	Erforderlich	Bonus-Guthaben, ein Ganzzahlwert multipliziert mit 10000
balance	Number	Erforderlich	Allgemeines Guthaben, Gleitkommazahl
gift_balance	Number	Erforderlich	Bonus-Guthaben, Gleitkommazahl
total_balance10000	Integer	Erforderlich	Gesamtguthaben, entspricht der Summe aus allgemeinem Guthaben und Bonus-Guthaben, ein Ganzzahlwert multipliziert mit 10000
total_balance	Number	Erforderlich	Gesamtguthaben, entspricht der Summe aus allgemeinem Guthaben und Bonus-Guthaben, Gleitkommazahl

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

Diesen Codeblock im schwebenden Fenster anzeigen

Entwicklungsempfehlung Es wird empfohlen, dass Aufrufer bevorzugt die Felder balance10000, gift_balance10000 und total_balance10000 verwenden, um das Guthaben selbst zu formatieren und so Probleme mit der Gleitkomma-Genauigkeit zu vermeiden.

Fehlerantwort

Der HTTP-Statuscode ist 4xx oder 5xx, und der Antworttext enthält die folgenden Felder:

Feld	Typ	Option	Beschreibung
code	Integer	Erforderlich	Fehlercode, siehe Beschreibungen der Fehlercodes
message	String	Erforderlich	Fehlerdetails

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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP-Code	Beschreibung
1000	500	Interner Fehler, bitte versuchen Sie es später erneut
2001	401	Authentifizierung fehlgeschlagen, falsches Token angegeben oder der zum Token gehörende Händler existiert nicht
2002	401	Authentifizierung fehlgeschlagen, Token abgelaufen oder deaktiviert
2002	403	Händler wurde gelöscht