GEThttps://onlinesim.io/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

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

Parameter

query6
NameTypBeschreibung
tzidstring

Operations-ID, wird vom Server bei der Ausgabe einer Nummer zurückgegeben (als Antwort auf eine getNum- oder getRentNum-Anfrage). Die Liste der aktiven Operationen des Profils mit ihren IDs kann auch über getState - für Empfangsoperationen - und über getRentState - für Mietoperationen - abgerufen werden. Wenn die Operations-ID nicht übergeben wird, enthält die Antwort Daten zu allen Operationen

paginationboolean

Paginierungsmodus für die Nachrichtenübersicht (wenn false - deaktiviert)

Standard:false
pageinteger
≥ 1

Seite der Nachrichten (nur relevant, wenn die Paginierung aktiviert ist)

per_pageinteger
≥ 1

Anzahl der Nachrichten pro Seite, Standard ist 20 (nur relevant, wenn die Paginierung aktiviert ist)

Standard:20
orderbystring

Sortierreihenfolge der SMS-Nachrichten nach ihrem Empfangszeitpunkt:

asc - Sortierung von ältesten zu neuesten;

desc - Sortierung von neuesten zu ältesten

Enumeration:ascdescStandard:desc
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:ru

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
schemaoneOf

Erfolgreiche Antwort oder ein allgemeiner Fehler. Ein OAuth-Token ohne rent-scope gibt einen Scope-Fehler zurück — siehe die Komponente tariffsRentOAuthScopeError

Eins von
[0]object
[1]object

Beispiele

Operation list with paginationexample_lines

Paginierte SMS-Liste

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "extension": 1,
      "messages": {
        "current_page": 1,
        "data": [
          {
            "id": 1,
            "service": "Google",
            "text": "G-249833 – Ваш проверочный код.",
            "code": "249833",
            "created_at": "2022-07-17 21:46:58"
          }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 1,
        "total": 1
      },
      "sum": 251.5,
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5750,
      "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
    }
  ]
}
Operation list with flat SMS arrayexample_lines

Flaches Array von SMS (pagination=false)

{
  "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.5,
      "country": 7,
      "checked_time": "2022-07-17 21:41:20",
      "number": "9915584307",
      "rent": 4,
      "tzid": 22867974,
      "time": 5750,
      "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
    }
  ]
}
Empty list

Keine aktiven Mietvorgänge

{
  "response": 1,
  "list": []
}

Codebeispiele

Beispiele werden generiert...