profile

Guthaben des Profils abrufen

GEThttps://onlinesim.io/api/getBalance.php

Gibt das Guthaben des Profils, die eingefrorenen Mittel und — auf Anfrage — die Partnereinnahmen zurück.

Nutzen Sie die Methode, um rechtzeitig aufzuladen (zum Beispiel vor WARNING_LOW_BALANCE-Fehlern von getNum).

Sicherheit

Parameter

query2
NameTypBeschreibung
incomestring

income und income_usd zur Antwort hinzufügen. Jeder nicht leere Wert außer 0 schaltet es ein (auch false); fehlend, leer oder 0 — aus.

Beispiel:1
langstring

Sprache der Texte in der Antwort (Länder- und Dienstnamen, Statustexte): fr, de, ru, en oder zh. Jede Methode akzeptiert ihn; Methoden ohne solche Texte antworten in jeder Sprache gleich. Feldnamen, Fehlercodes und andere feste Werte bleiben auf Englisch. Ohne den Parameter: ru für getTariffs, getNumbersStats und getFreeList; sonst die Sprache des Profils bei Anfragen mit Schlüssel, Englisch bei Anfragen ohne. Ein nicht unterstützter Wert wird durch die Standardsprache ersetzt

Enumeration:frderuenzh

Antworten

200Guthaben oder ein allgemeiner Fehler
Content-Typeapplication/json
Schema
schemaoneOfGuthaben (mit Partnereinnahmen, wenn income gesetzt ist) oder ein allgemeiner Fehler
Eins von
[0]object
[1]allOf
[2]object

Beispiele

Balance

Guthaben und eingefrorene Mittel

{
  "response": "1",
  "balance": "106.32",
  "zbalance": 0.36
}
With income

Mit income=1: Partnereinnahmen hinzugefügt

{
  "response": "1",
  "balance": "106.32",
  "zbalance": 0.36,
  "income": 12.5,
  "income_usd": "13.200"
}
429HTTP 429: mehr als 400 Anfragen pro Minute von einem Profil (von einer IP bei Anfragen ohne Schlüssel) oder mehr als 200 Anfragen pro Minute von einem Profil an getNum, getPrice, getState und setOperationOk zusammen
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Rate limit

Anfragelimit überschritten

{
  "response": "TRY_AGAIN_LATER"
}
456HTTP 456: Der API-Schlüssel ist ungültig oder das OAuth-Token ist abgelaufen. Öffentliche Methoden antworten genauso, wenn ein ungültiger Schlüssel übergeben wird
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Invalid key

Ungültiger API-Schlüssel oder abgelaufenes Token

{
  "response": "ERROR_WRONG_KEY"
}

Codebeispiele

Beispiele werden generiert...