single-service activations

Informationen über Nummern mit aktiven Vorgängen erhalten

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

Liefert die Vorgänge Ihres Kontos mit Status und empfangenen SMS — der Bereich „Meine Nummern“ im persönlichen Konto. tzid beschränkt die Antwort auf einen Vorgang. POST mit denselben Parametern funktioniert ebenfalls.

  • msg enthält die aktuelle SMS: standardmäßig den Code, mit message_to_code=0 den vollständigen Text, mit msg_list=1 alle SMS. setOperationRevise schaltet die aktuelle SMS auf die nächste weiter.
  • Antworten werden 5 Sekunden lang zwischengespeichert: Dieselbe Anfrage erhält früher dieselbe Antwort. Ohne tzid wird ein setOperationRevise-Aufruf daher erst nach dieser Zeit sichtbar.

Aktive Vorgänge

Sicherheit

Parameter

query10
NameTypBeschreibung
tzidinteger

Vorgangs-ID: nur diesen Vorgang zurückgeben

message_to_codeinteger

1 — nur der Code aus der SMS, 0 — der vollständige Text; 2 mit msg_list=1 — beides (text und code). Andere Werte als 1, true, yes, on und 2 gelten als 0

Enumeration:012Standard:1
orderbystring

Reihenfolge der Vorgänge in der Liste nach Vorgangs-ID: desc — neueste zuerst, asc — älteste zuerst. Nur Kleinbuchstaben

Enumeration:ascdescStandard:desc
msg_listinteger

1 — msg ist eine Liste aller SMS des Vorgangs, 0 — nur die aktuelle SMS

Enumeration:01Standard:0
cleaninteger

Nur mit msg_list=0. Mit diesem Parameter (beliebiger Wert, auch 0) ist msg false, sobald setOperationRevise über die letzte SMS hinaus weitergeschaltet hat; ohne ihn beginnen die SMS wieder bei der ersten

lastinteger

Nur mit msg_list=0. 1 — msg ist die neueste SMS statt der aktuellen

Enumeration:01Standard:0
numberboolean

Mit diesem Parameter (beliebiger Wert, auch 0) hat jeder Vorgang zusätzlich guard_interval_remaining_seconds

with_responseinteger

1 — die Liste kommt als {"response": "1", "list": [...]} statt als einfaches Array

Enumeration:01Standard:0
textinteger

Nur mit tzid. 1 — die Antwort ist nur msg dieses Vorgangs als JSON-String; vor der ersten SMS (und bei einem Vorgang ohne Nummer) ist es ein leerer String

Enumeration:01Standard:0
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

200Vorgänge oder ein Fehler
Content-Typeapplication/json
Schema
schemaoneOf
Eins von
[0]object[]Vorgänge des Kontos (nie leer: ohne Vorgänge lautet die Antwort ERROR_NO_OPERATIONS)
[1]objectMit with_response
[2]string
Mit tzid und text: nur msg dieses Vorgangs
[3]object
[4]object

Beispiele

success

Ein Vorgang mit einer SMS

[
  {
    "country": 373,
    "sum": 0.36,
    "service": "telegram",
    "number": "+37360000000",
    "webhook_url": null,
    "subscription_package_id": null,
    "response": "TZ_NUM_ANSWER",
    "tzid": 10000,
    "time": 596,
    "msg": "123456",
    "form": "index"
  }
]
ERROR_NO_OPERATIONS

Keine Vorgänge

{
  "response": "ERROR_NO_OPERATIONS"
}
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...