rent

Informationen zum Status der Mietoperation erhalten

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

Diese Anfrage gibt eine Liste aktiver Mietnummern zurück: Vorgänge mit status 0, 1 oder 4.

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

SMS in messages sind immer neueste zuerst. Eine nicht numerische tzid oder ein falsches orderby ergibt TRY_AGAIN_LATER. POST mit denselben Parametern funktioniert ebenfalls.

Sicherheit

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

Parameter

query9
NameTypBeschreibung
tzidinteger

ID des Mietvorgangs: nur dieser Vorgang. Ohne sie (oder mit 0) alle aktiven Mietvorgänge

paginationboolean

true (Standard) — messages eines Mietvorgangs wird in Seiten aufgeteilt (siehe page und per_page); false — messages ist eine flache Liste von SMS, neueste zuerst

Standard:true
pageinteger
≥ 1

Eine Seite der Nachrichten, ab 1 gezählt: page=N gibt nur die Seite N zurück, data ist dann eine flache Liste von SMS. Werte unter 1 werden zu 1. Ohne den Parameter werden alle Seiten zurückgegeben. Nur mit Paginierung

per_pageinteger
≥ 1

Anzahl der Nachrichten pro Seite, Standard ist 20; Werte unter 1 werden zu 1 (nur relevant, wenn die Paginierung aktiviert ist)

Standard:20
orderbystring

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

Enumeration:ascdescStandard:desc
lastboolean

true — messages enthält nur den Code der neuesten SMS (eine leere Zeichenkette, wenn es keine gibt)

Standard:false
message_to_codeboolean

Mit last=true: false — messages enthält den Text der neuesten SMS statt ihres Codes

Standard:true
numberinteger

Beliebiger Wert: Jedes Element enthält zusätzlich time_seconds und guard_interval_remaining_seconds

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

200Aktive Mietvorgänge oder ein Fehler
Content-Typeapplication/json
Schema
schemaoneOf
Eins von
[0]object
[1]object

Beispiele

Operation list with paginationZeilen: 53

Paginierte SMS-Liste

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "messages": {
        "current_page": 1,
        "data": [
          [
            {
              "id": 1,
              "service": "Google",
              "text": "G-070051 is your Google verification code.",
              "code": "070051",
              "created_at": "2026-11-19 10:01:12"
            }
          ]
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 20,
        "to": 1,
        "total": 1
      },
      "country": 7,
      "rent": 4,
      "days_autoextend": 3,
      "extension": 1,
      "checked_time": "2026-11-19 10:00:00",
      "sum": "2.40",
      "number": "9915584307",
      "start_time": "2026-11-19 10:00:00",
      "stop_time": "2026-11-23 10:00:00",
      "webhook_url": null,
      "tzid": 22867974,
      "time": 2880,
      "days": 2,
      "hours": 48,
      "extend": {
        "1": 0.9,
        "3": 1.5,
        "7": 3,
        "15": 5.5,
        "30": 9
      },
      "checked": true,
      "reload": 0,
      "day_extend": 0.3,
      "m_ext": false,
      "freeze": false
    }
  ]
}
Operation list with flat SMS arrayZeilen: 43

Flaches Array von SMS (pagination=false)

{
  "response": 1,
  "list": [
    {
      "status": 1,
      "messages": [
        {
          "id": 1,
          "service": "Google",
          "text": "G-070051 is your Google verification code.",
          "code": "070051",
          "created_at": "2026-11-19 10:01:12"
        }
      ],
      "country": 7,
      "rent": 4,
      "days_autoextend": 3,
      "extension": 1,
      "checked_time": "2026-11-19 10:00:00",
      "sum": "2.40",
      "number": "9915584307",
      "start_time": "2026-11-19 10:00:00",
      "stop_time": "2026-11-23 10:00:00",
      "webhook_url": null,
      "tzid": 22867974,
      "time": 2880,
      "days": 2,
      "hours": 48,
      "extend": {
        "1": 0.9,
        "3": 1.5,
        "7": 3,
        "15": 5.5,
        "30": 9
      },
      "checked": true,
      "reload": 0,
      "day_extend": 0.3,
      "m_ext": false,
      "freeze": false
    }
  ]
}
Empty list

Keine aktiven Mietvorgänge

{
  "response": 1,
  "list": []
}
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...