Onlinesim API

v1.1

Allgemeine Beschreibung

Diese API ermöglicht es Ihnen, Zugriff auf alle von Onlinesim bereitgestellten Dienste zu erhalten:

  • SMS-Empfang von einem bestimmten Dienst auf eine virtuelle Nummer;
  • Vermietung einer virtuellen Nummer zum Empfang von SMS von mehreren verschiedenen Absendern über einen längeren Zeitraum;
  • Sie können auch unsere kostenlosen Nummern nutzen, um die Funktionalität des Dienstes vor dem Kauf zu testen.

Liste der API-Anfragen

Anfragen unterscheiden sich je nach Art des Dienstes und sind in entsprechende Unterabschnitte unterteilt:

Abschnitt "Profil"

Diese Anfragen beziehen sich entweder auf das Kundenprofil oder auf alle von Onlinesim bereitgestellten Dienste gleichzeitig:

  • getBalance - gibt das aktuelle verfügbare Guthaben Ihres Profils, das eingefrorene Guthaben (reservierte Mittel für aktive Vorgänge, die bei deren Stornierung zurückerstattet werden) und Informationen über Einnahmen aus dem Empfehlungsprogramm zurück.
  • webhook - ermöglicht es Ihnen, einen URI festzulegen, an den alle Nachrichten von Ihren aktiven Vorgängen weitergeleitet werden. Dies betrifft sowohl SMS vom Dienst "SMS-Empfang" als auch von "Nummer mieten".

Abschnitt "SMS-Empfang"

Ermöglicht es, eine Nummer zum Empfang einer unbegrenzten Anzahl von SMS von einem ausgewählten Dienst innerhalb eines kurzen Zeitraums (für die meisten Dienste - 15 Minuten) zu erhalten. Bitte beachten Sie, dass Sie den Dienst während des Vorgangs nicht ändern können. Um SMS von verschiedenen Diensten zu empfangen, müssen Sie neue Nummern mit entsprechenden Parametern bestellen.

  • getTariffs - fragt die Anzahl verfügbarer Nummern ab, gruppiert nach Ländern und Diensten (wenn solche in der Anfrage angegeben sind);
  • getNum - bestellt eine Nummer des ausgewählten Landes zum Empfang von SMS vom angegebenen Dienst;
  • getState - gibt detaillierte Informationen über alle aktiven Nummern Ihres Profils zurück (einschließlich der von ihnen empfangenen SMS-Nachrichten);
  • setOperationRevise - fordert die nächste von dieser Nummer empfangene SMS-Nachricht aus der Warteschlange an, wenn die erste nicht den erforderlichen Code und/oder die benötigten Informationen enthielt.
  • setOperationOk - ändert den Status des Vorgangs auf erfolgreich abgeschlossen und schließt ihn.

Abschnitt "Miete"

Dieser Dienst setzt voraus, dass die Nummer zum Empfang von SMS von vielen verschiedenen Absendern (einschließlich SMS von anderen Mobilnummern) verwendet wird, mit Ausnahme verbotener.

  • tariffsRent - fragt eine Liste von Ländern mit detaillierten Informationen zu Miettarifen ab;
  • getRentNum - bestellt eine Nummer des ausgewählten Landes zur Miete für den angegebenen Zeitraum;
  • extendRentState - verlängert die Miete der ausgewählten Nummer;
  • getRentState - gibt eine Liste der Nummern Ihres Profils mit aktiver Miete und von ihnen empfangenen Nachrichten zurück;
  • closeRentNum - schließt den Mietvorgang.

Abschnitt "Kostenlose Nummern"

Diese API bietet Zugriff auf die Funktionalität zur Verwendung kostenloser Onlinesim-Nummern, die auf der Hauptseite der Website zu finden sind.

Sie können kostenlose Nummern zum Testen der von uns bereitgestellten Dienste verwenden, wir bitten Sie jedoch zu beachten, dass die Anzahl verfügbarer Länder und Nummern begrenzt ist. Es ist auch zu beachten, dass Nachrichten, die auf kostenlose Nummern empfangen werden, nicht privat sind, sie werden im entsprechenden Widget auf der Hauptseite angezeigt und sind anderen Benutzern der Website zugänglich.

In dieser API ist eine universelle Anfrage verfügbar, die Ihnen Zugriff auf alle erforderlichen Informationen zur Verwendung kostenloser Nummern bietet:

  • getFreeList - gibt detaillierte Informationen über die Liste verfügbarer Länder, kostenloser Nummern und Nachrichten zurück, die sie empfangen haben.

Die Anfragensammlung für Postman ist hier verfügbar:

Run In Postman

Dokumentation in Postman

Jede Anfrage enthält ihre Beschreibung, Typ, URL-Endpunkt, Parameter, Beispiele für Anfrage- und Antwortkörper. In der Beschreibung einzelner Anfragen kann auch eine Liste spezifischer Fehler angegeben werden, die als Antwort erhalten werden und bei Aufruf dieser Methoden auftreten können. Antworten werden im JSON- oder TXT-Format dargestellt, abhängig von der aufgerufenen Methode und den Ergebnissen.

Ausnahmebehandlung

Im Folgenden sind allgemeine Fehler aufgeführt: Sie sind nicht an einen bestimmten Endpunkt gebunden und können in mehreren Methoden auftreten. Solche Antworten kommen immer mit dem HTTP-Status 200, und der Fehlercode wird im Feld response übergeben:

{
  "response": "ERROR_CODE"
}

Verarbeitungsregeln

  1. Codeformat — UPPER_SNAKE_CASE
  2. Die Liste der Codes ist nicht geschlossen — sie kann erweitert werden
  3. Ein unbekannter Code sollte als allgemeiner Fehler behandelt und zur Untersuchung protokolliert werden
Code Kategorie Beschreibung
UNDEFINED_COUNTRY Anfrageparameter Ungültiger Wert des Länderparameters. Verfügbare Werte finden Sie in der Länderliste
UNDEFINED_DAYS Anfrageparameter 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 Anfrageparameter Ungültiger Wert des Dienstparameters. Verfügbare Werte finden Sie in der Dienste-Liste
NO_NUMBER Status und Verfügbarkeit Keine verfügbaren Nummern mit den angegebenen Parametern. Versuchen Sie es später erneut oder ändern Sie die Bestellparameter (Land und Dienst für den Empfang, Land und Dauer für die Miete)
WARNING_LOW_BALANCE Status und Verfügbarkeit Unzureichendes Guthaben, um eine Nummer zu bestellen
ACCOUNT_BLOCKED Konto und Zugriff Konto ist gesperrt, wenden Sie sich an den Support
API_ACCESS_DISABLED Konto und Zugriff API-Zugriff ist in den Profileinstellungen deaktiviert (der Schalter API enthalten ist inaktiv)
API_ACCESS_IP Konto und Zugriff IP-Adresse ist nicht in der Allowlist (siehe Zugriff von IP)
ERROR_WRONG_KEY Autorisierung Ungültiger API-Schlüssel
ERROR_NO_KEY Autorisierung API-Schlüssel fehlt
INTERVAL_CONCURRENT_REQUESTS_ERROR Anfragelimits Die zulässige Häufigkeit oder Anzahl gleichzeitiger Anfragen wurde überschritten. Reduzieren Sie die Intensität der Anfragen und versuchen Sie es später erneut
REQUEST_NOT_FOUND Routing Der Methodenname ist ungültig oder fehlt
TRY_AGAIN_LATER Sonstiges Ein unerwarteter Fehler ist aufgetreten, versuchen Sie die Anfrage später erneut

Terms of Service: https://onlinesim.io/documentation/offer

Kontakt

Lizenz

GNU General Public License, version 3.0

Server

https://onlinesim.io

Onlinesim-Server