Skip to content

GET /api/getState.php

Informationen über Nummern mit aktiven Vorgängen erhalten

Gibt detaillierte Informationen über alle aktiven Nummern des Profils zurück (oder nur über die angegebene Nummer).

Ermöglicht es, den Status der Vorgänge Ihres Kontos zu überprüfen und die auf Ihre bestellten Nummern empfangenen SMS-Nachrichten zu lesen.

Sie können diese Anfrage verwenden, um eine Liste aller Nachrichten von aktiven Nummern für deren anschließende Verarbeitung zu erhalten.

Ist faktisch eine Repräsentation des Blocks aktiver Vorgänge ("Meine Nummern") des persönlichen Kontos.

Aktive Vorgänge

Sicherheit

  • apikey
  • BearerAuth
  • OAuth2 (Berechtigungen: sms-scope)
    • sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Parameter

NameTypBeschreibung
tzidinteger
≥ 1

Vorgangs-ID

Beispiel:10000
message_to_codeinteger

SMS-Anzeigemodus:

0 - die gesamte SMS anzeigen,

1 - nur den Code aus der SMS anzeigen

Enumeration:01Beispiel:1
orderbystring

Sortierreihenfolge:

asc - aufsteigend sortieren;

desc - absteigend sortieren

Enumeration:ascdescStandard:ascBeispiel:asc
msg_listinteger
≥ 0, ≤ 1

Anzeigemodus der Nachrichtenliste:

0 - nur die aktive Nachricht,

1 - als Liste

Enumeration:01Beispiel:1
cleaninteger
≥ 0, ≤ 1

Nachrichtenanzeigemodus (nur für msg_list = 0):

0 - zuvor angezeigte Nachrichten anzeigen,

1 - zuvor angezeigte Nachrichten nicht anzeigen

Enumeration:01Beispiel:1
langstring

Antwortsprache:

fr - Französisch,

de - Deutsch,

ru - Russisch,

en - Englisch,

zh - Chinesisch.
Beachten Sie, dass die Übersetzung nur für Zeichenfolgenwerte von Feldern durchgeführt wird, z. B. Namen von Diensten oder Ländern. Die Feldnamen selbst, Fehler bei der Ausführung von Anfragen und allgemein akzeptierte Werte (z. B. Werte von Feldern true/false für boolesche Parameter) bleiben auf Englisch.

Enumeration:frderuenzhStandard:ruBeispiel:en

Antworten

200

Erfolgreiche Antwort auf die Anfrage getState: Der Server gibt aktuelle Informationen über die aktiven Nummern Ihres Kontos zurück oder wirft eine Ausnahme.

Codebeispiele