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

GET /api/rent/tariffsRent.php

Informationen zu Tarifen für die Miete von Nummern erhalten

Abrufen von Informationen über verfügbare Nummern für die Miete des angegebenen Landes (oder aller Länder, wenn kein spezifisches angegeben ist): Tarife und andere Mietparameter.

Im Gegensatz zum normalen SMS-Empfang bedeutet die Miete einer Nummer eine längere Nutzungsdauer. Im Gegensatz zum normalen Empfang können Sie während der gesamten Mietdauer eine beliebige Anzahl von SMS-Nachrichten von verschiedenen Absendern erhalten: von Websites und Apps bis hin zu SMS von normalen Mobilnummern.

Wenn Sie ursprünglich eine Nummer mit Verlängerungsmöglichkeit gewählt haben, können Sie die Miete jederzeit vor ihrem Ende verlängern.

Sicherheit

apikey

BearerAuth

OAuth2Berechtigungen: rent-scope

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

Parameter

query2

Name	Typ	Beschreibung
`country`	`string`	Ländercode (gemäß Länderliste)
`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`

Antworten

200

Erfolgreiche Antwort auf die Anfrage tariffsRent: Der Server gibt Informationen über verfügbare Miettarife zurück oder wirft eine Ausnahme

Content-Typeapplication/json

Schema

ResponseoneOf

Erfolgreiche Antwort (alle Länder, ein einzelnes Land oder ein leeres Array) oder ein Fehler (methodenspezifisch oder allgemein)

Eins von

[0]object

Länderkarte. Schlüssel sind Ländercodes als Zeichenketten (z. B. "7", "46", "373"), Werte sind rentCountryTariff-Objekte

[additionalProperties]object

codeintegerErforderlich

Ländercode (gemäß Länderliste)

enabledbooleanErforderlich

Flag für die Verfügbarkeit der Miete virtueller Telefonnummern dieses Landes (true - Miete ist verfügbar)

namestringErforderlich

Länder-Slug (z. B. russia, moldova)

newbooleanErforderlich

Service-Flag zur Kennzeichnung eines kürzlich hinzugefügten Landes

positionintegerErforderlich

Position des Landes in der Standardliste

countobjectErforderlich

Verfügbare Nummern nach Mietdauer. Schlüssel sind Zeiträume in Tagen (1, 3, 7, 15, 30), Werte sind Mengen

[additionalProperties]integer

≥ 0

daysobjectErforderlich

Preise für dieselben Mietdauern. Schlüssel sind Zeiträume in Tagen, Werte sind Preise

[additionalProperties]number

≥ 0

extendintegerErforderlich

Anzahl der Nummern mit Verlängerungsmöglichkeit

≥ 0

confirmboolean

true — die Mittel werden sofort abgebucht, es gibt keine automatische Rückerstattung, wenn keine SMS eingeht (im Dashboard wird vor dem Kauf eine zusätzliche Bestätigung angezeigt)

[1]object

codeintegerErforderlich

Ländercode (gemäß Länderliste)

enabledbooleanErforderlich

Flag für die Verfügbarkeit der Miete virtueller Telefonnummern dieses Landes (true - Miete ist verfügbar)

namestringErforderlich

Länder-Slug (z. B. russia, moldova)

newbooleanErforderlich

Service-Flag zur Kennzeichnung eines kürzlich hinzugefügten Landes

positionintegerErforderlich

Position des Landes in der Standardliste

countobjectErforderlich

Verfügbare Nummern nach Mietdauer. Schlüssel sind Zeiträume in Tagen (1, 3, 7, 15, 30), Werte sind Mengen

[additionalProperties]integer

≥ 0

daysobjectErforderlich

Preise für dieselben Mietdauern. Schlüssel sind Zeiträume in Tagen, Werte sind Preise

[additionalProperties]number

≥ 0

extendintegerErforderlich

Anzahl der Nummern mit Verlängerungsmöglichkeit

≥ 0

confirmboolean

true — die Mittel werden sofort abgebucht, es gibt keine automatische Rückerstattung, wenn keine SMS eingeht (im Dashboard wird vor dem Kauf eine zusätzliche Bestätigung angezeigt)

[2]object[]

Leeres Array, wird bei einem unbekannten Land zurückgegeben

maxItems: 0

[3]object

responsestringErforderlich

Fehler, der zurückgegeben wird, wenn das OAuth-Token den Scope rent-scope nicht enthält: "Invalid scope(s) provided: rent-scope"

[4]object

responsestringErforderlich

Fehlercode im Format UPPER_SNAKE_CASE, wird im Feld response bei HTTP-Status 200 zurückgegeben. Die Liste der Codes ist nicht abgeschlossen und kann erweitert werden. Ein unbekannter Code sollte als allgemeiner Fehler behandelt und zur Analyse protokolliert werden.

Bekannte Codes, nach Bedeutung gruppiert:

Anfrageparameter

UNDEFINED_COUNTRY — ungültiger Wert des Ländparameters. Verfügbare Werte — in der Länderliste;
UNDEFINED_DAYS — ungültige Miet- oder Verlängerungsdauer. Gültige Werte finden Sie im Objekt days der Antwort tariffsRent für Basismietdauern und im Objekt extend der Antwort getRentState für Verlängerungen;
ERROR_NO_SERVICE — ungültiger Wert des Serviceparameters. Verfügbare Werte — in der Dienstliste.

Status und Verfügbarkeit

NO_NUMBER — keine verfügbaren Nummern mit den angegebenen Parametern. Versuchen Sie es später erneut oder versuchen Sie, eine Nummer aus einem anderen Land zu bestellen;
WARNING_LOW_BALANCE — unzureichendes Guthaben.

Konto und Zugriff

ACCOUNT_BLOCKED — Konto ist gesperrt;
API_ACCESS_DISABLED — API-Zugriff ist in den Profileinstellungen deaktiviert (siehe Schalter API enthalten);
API_ACCESS_IP — IP-Adresse ist nicht in der Allowlist (siehe Feld Zugriff von IP).

Autorisierung

ERROR_WRONG_KEY — ungültiger API-Schlüssel;
ERROR_NO_KEY — API-Schlüssel fehlt.

Anfragelimits

INTERVAL_CONCURRENT_REQUESTS_ERROR — die zulässige Häufigkeit oder Anzahl gleichzeitiger Anfragen wurde überschritten.

Routing

REQUEST_NOT_FOUND — der Name der aufgerufenen Methode ist falsch oder fehlt.

Sonstiges

TRY_AGAIN_LATER — unerwarteter Fehler

Beispiele

List of number rental tariffs for all countries25 Zeilen

Liste der Miet- und Verlängerungsfristen und -tarife für alle Länder

{
  "7": {
    "code": 7,
    "enabled": true,
    "name": "russia",
    "new": false,
    "position": 7,
    "count": {
      "1": 1153,
      "3": 1153,
      "7": 1153,
      "15": 1153,
      "30": 1153
    },
    "days": {
      "1": 121,
      "3": 215.5,
      "7": 400,
      "15": 700,
      "30": 1078.5
    },
    "extend": 1153,
    "confirm": false
  }
}

List of number rental tariffs for one country23 Zeilen

Liste der Miet- und Verlängerungsfristen und -tarife für das angegebene Land

{
  "code": 7,
  "enabled": true,
  "name": "russia",
  "new": false,
  "position": 7,
  "count": {
    "1": 1153,
    "3": 1153,
    "7": 1153,
    "15": 1153,
    "30": 1153
  },
  "days": {
    "1": 121,
    "3": 215.5,
    "7": 400,
    "15": 700,
    "30": 1078.5
  },
  "extend": 1153,
  "confirm": false
}

Codebeispiele

Beispiele werden generiert...