gethttps://onlinesim.io/api/getTariffs.php

GET /api/getTariffs.php

Informationen über Tarife für den Dienst "SMS-Empfang" erhalten

Diese Anfrage ermöglicht es, Informationen über Tarife für den Dienst "SMS-Empfang" zu erhalten.

Im Wesentlichen ist es eine Repräsentation der Dienstliste (Block "Nummer kaufen"), die sich im persönlichen Konto befindet.

Dienstliste

Parameter

query7
NameTypBeschreibung
locale_pricestring

Preis in der Währung Ihres Guthabens (standardmäßig USD)

countrystring

Ländercode (gemäß Länderliste)

filter_countrystring

Filter für Länder (verwirft Länderobjekte, die nicht mit dem Zielland zusammenhängen, und behält nur das angeforderte bei)

filter_servicestring

Filter für den Dienst (verwirft Dienstobjekte, die nicht mit dem Zieldienst zusammenhängen, und behält nur den angeforderten bei)

countstring

Anzahl der Dienste, die auf einer Seite der Antwort angezeigt werden

pagestring

Seite der Tarifliste (Navigation durch Paginierung)

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 (mit response: "1") oder Fehler (mit response: "ERROR_CODE")

Content-Typeapplication/json
Schema
ResponseoneOf

Erfolgreiche Antwort auf getTariffs oder ein allgemeiner Fehler

Eins von
[0]object
responsestringErforderlich

"1", wenn die Anfrage erfolgreich ausgeführt wurde, andernfalls wird eine Fehlermeldung ausgegeben. Zur Behandlung allgemeiner Fehler siehe den Abschnitt Verarbeitungsregeln

Enumeration:1
countriesobjectErforderlich

Länderkarte. Schlüssel sind Ländercodes mit Präfix _ (z. B. _7, _380)

[additionalProperties]object
namestringErforderlich

Ländername für die Anzeige in der Benutzeroberfläche

originalstringErforderlich

Ländername, der bei der Bestellung einer Nummer erforderlich ist. Verfügbare Werte sind in der countries-Antwort aufgeführt

codeintegerErforderlich

Internationale Vorwahl des Landes

posintegerErforderlich

Position des Landes in der Standardliste

otherbooleanErforderlich

Verfügbarkeit des Dienstes "Andere Websites" für dieses Land

newbooleanErforderlich

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

enablebooleanErforderlich

Service-Flag zur Kennzeichnung der Möglichkeit, eine Nummer für das Land zu bestellen

servicesobjectErforderlich

Dienste-Karte für das ausgewählte Land. Schlüssel sind Dienst-Slugs mit Präfix _ (z. B. _vkcom, _telegram)

[additionalProperties]object
idintegerErforderlich

Service-ID (Standardposition in der Liste, Servicefeld)

countintegerErforderlich

Anzahl der verfügbaren Nummern für diesen Dienst

≥ 0
pricestringErforderlich

Preis des Dienstes. Mit locale_price — in der Währung Ihres Guthabens

servicestringErforderlich

Vollständiger Name des Dienstes

slugstringErforderlich

Kurzer Dienstschlüssel, der für die Bestellung erforderlich ist

favorite_countriesobject

Favoritenländer (leer, wenn der Client nicht angemeldet ist)

favorite_servicesobject[]

Favoritendienste (leer, wenn der Client nicht angemeldet ist)

itemsobject
pageinteger

Aktuelle Seite der Dienstpaginierung

≥ 1
countryinteger

Ausgewählter Ländercode (entspricht dem Wert in der Anfrage)

filterstring

Filterzeichenfolge aus der Anfrage

endboolean

true, wenn auf der nächsten Seite keine Dienste mehr vorhanden sind (Ende der Liste)

favoritesobject

Servicefeld; normalerweise ein leeres Objekt, wenn keine Favoritendienste vorhanden sind

[1]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 tariffs provided30 Zeilen

Erfolgreiche Antwort

{
  "response": "1",
  "countries": {
    "_7": {
      "name": "Russia",
      "original": "russia",
      "code": 7,
      "pos": 0,
      "other": false,
      "new": false,
      "enable": true
    }
  },
  "services": {
    "_vkcom": {
      "id": 1,
      "count": 3721,
      "price": "0.55",
      "service": "VKontakte",
      "slug": "vkcom"
    }
  },
  "favorite_countries": {},
  "favorite_services": [],
  "page": 1,
  "country": 7,
  "filter": "",
  "end": false,
  "favorites": {}
}

Codebeispiele

Beispiele werden generiert...