gethttps://onlinesim.io/api/rent/getRentState.php

GET /api/rent/getRentState.php

Informationen zum Status der Mietoperation erhalten

Diese Anfrage gibt eine Liste aktiver Mietnummern zurück.

Sie können sie verwenden, um schnell alle aktiven Mietnummern (oder nur eine von Ihnen ausgewählte) und die von ihnen empfangenen Nachrichten anzuzeigen.

Sicherheit

apikey

BearerAuth

OAuth2Berechtigungen: rent-scope

rent-scope: grants access to renting phone numbers from Onlinesim

Parameter

query3

Name	Typ	Beschreibung
`tzid`	`integer`	Vorgangs-ID. Wenn nicht angegeben, gibt die Anfrage die vollständige Liste der Mietnummern Ihres Profils zurück.
`pagination`	`boolean`	Paginierungsmodus für die Nachrichtenübersicht (wenn `false` - deaktiviert) Standard:`false`Beispiel:`false`
`lang`	`string`	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:`frderuenzh`Standard:`ru`Beispiel:`en`

Antworten

200

Erfolgreiche Antwort auf die Anfrage getRentState: Der Server gibt Informationen über den angegebenen aktiven Mietvorgang (oder über alle aktuellen Mietvorgänge) zurück oder wirft eine Ausnahme.

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

1, wenn die Anfrage erfolgreich ausgeführt wurde, oder gibt eine Fehlermeldung aus

Beispiel:1

Eins von

[0]integer

[1]string

listobject[]

Liste der aktuellen Mietvorgänge

itemsobject

statusinteger

Mietstatuscode, unmittelbar nach der Ausgabe immer 0:

0 - Warten auf Bestätigung des Vorgangs (SMS muss innerhalb von 20 Minuten nach der Bestellung empfangen werden, andernfalls wird der Vorgang storniert und die Mittel auf das Kontoguthaben zurückerstattet)

1 - Miete aktiv

2 - DEPRECATED Nummer deaktiviert

3 - DEPRECATED Mietfehler

4 - Nummer wurde eingefroren

Enumeration:01234Beispiel:1

extensioninteger

Verfügbarkeit der Verlängerung der Miete dieser Nummer:

0 - Verlängerung nicht verfügbar

1 - Verlängerung verfügbar

2 - Auto-Verlängerung (die Miete wird automatisch um 30 Tage verlängert, wenn der aktuelle Zeitraum abläuft und ausreichend Guthaben vorhanden ist)

Enumeration:012Beispiel:1

messagesobject[]

itemsobject

idinteger

Nachrichten-ID

≥ 1

Beispiel:1

servicestring

Nummer oder Name des Absenders

Beispiel:Google

textstring

Text der SMS-Nachricht

Beispiel:Your verification code is 070051

codestring

Numerischer Code aus der SMS-Nachricht

Beispiel:070051

created_atstring

Datum und Uhrzeit des SMS-Empfangs

Beispiel:2022-07-17 21:46:58

sumstring

Gesamtkosten der Miete (anfänglicher Zeitraum + Verlängerungszeiträume)

Beispiel:251.5

countryinteger

Internationaler Telefoncode des Landes (gemäß E.164-Standard, ohne "+"-Zeichen), siehe Liste der Länder

Beispiel:46

checked_timestring

Datum und Uhrzeit der Nummernübernahme

Beispiel:2022-07-17 21:41:20

numberstring

Ausgegebene virtuelle Nummer (ohne Ländercode)

Beispiel:9915584307

rentinteger

Mietstatuscode, unmittelbar nach der Ausgabe immer 0:

1 - Miete aktiv

2 - DEPRECATED Nummer deaktiviert

3 - DEPRECATED Mietfehler

4 - Nummer wurde eingefroren

Enumeration:01234Beispiel:4

tzidinteger

Vorgangs-ID

≥ 1

Beispiel:10000

timeinteger

Verbleibende Mietzeit (in Minuten)

≥ 1

Beispiel:5750

daysinteger

Verbleibende Mietzeit (in Tagen)

≥ 0

Beispiel:3

hoursinteger

Verbleibende Mietzeit (in Stunden)

≥ 1

Beispiel:95

extendobject

Verlängerungskosten

#period_in_days#integer

Kosten für jeden verfügbaren Verlängerungszeitraum

≥ 1

Beispiel:36

checkedboolean

Aktivierungsstatus der Nummer (zur Aktivierung muss die Nummer innerhalb von 20 Minuten nach Beginn des Vorgangs eine SMS empfangen, andernfalls wird automatisch eine Rückerstattung durchgeführt und der Vorgang geschlossen)

reloadinteger

Verfügbarkeit des Neustarts der Nummer:

0 - Neustart nicht verfügbar

1 - Neustart verfügbar

Beispiel:1

day_extendinteger

Kosten für die Verlängerung der Miete um 1 Tag

≥ 1

Beispiel:36

m_extboolean

Analoger Algorithmus für die Verlängerung

freezeboolean

Status der "Einfrierung" der Nummer: wenn true - Nummer ist eingefroren, und um die Miete fortzusetzen, muss sie aufgetaut werden

Beispiele

Successful response to get all active rental operations39 Zeilen

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "extension": 1,
      "messages": [
        {
          "id": 1,
          "service": "Google",
          "text": "G-249833 – Ваш проверочный код.",
          "code": "249833",
          "created_at": "2022-07-17 21:46:58"
        }
      ],
      "sum": "251.50",
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5728,
      "days": 3,
      "hours": 95,
      "extend": {
        "1": 36,
        "3": 108,
        "7": 252,
        "15": 540,
        "30": 1080
      },
      "checked": true,
      "reload": 0,
      "day_extend": 36,
      "m_ext": false,
      "freeze": false
    }
  ]
}

Codebeispiele

Beispiele werden generiert...