Onlinesim API
v1.1Allgemeine 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 Guthaben Ihres Profils (einschließlich eingefrorener Mittel), den eingefrorenen Teil (reservierte Mittel für aktive Vorgänge, die bei deren Abbruch zurückgegeben werden) und Ihre Einnahmen aus dem Partnerprogramm 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".
- getProfile - gibt die Profileinstellungen zurück, einschließlich der Standardwerte für die API (Land, ausgeschlossene Präfixe, Webhook-URL);
- profile.php - ändert die Profileinstellungen, z. B. setzt oder löscht die Webhook-URL;
- getPaymentHistory - gibt den Verlauf der Aufladungen zurück;
- webhook-logs - gibt das Protokoll der Webhook-Zustellungen zurück.
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);
- getNumbersStats - gibt Preise und Bestand an Nummern nach Ländern und Diensten zurück;
- getPrice - gibt den Preis einer Nummer für einen Dienst in einem Land zurück;
- 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:
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. Alle Antworten sind JSON.
Bibliotheken
Offizielle Client-Bibliotheken für diese API. Jede enthält einen eingebauten Mock für Tests ohne Netzwerk und Guthaben.
| Sprache | Paket | Dokumentation |
|---|---|---|
| JavaScript / TypeScript | npm onlinesim-js-api |
Dokumentation |
| PHP | Composer s00d/onlinesim-api |
Dokumentation |
| Python | PyPI onlinesimru |
Dokumentation |
| Go | github.com/s00d/onlinesim-go-api/v3 |
Dokumentation |
| Rust | crates.io onlinesim-rs-api |
Dokumentation |
| Java | Maven ru.onlinesim:onlinesim-api |
Dokumentation |
| Kotlin | Maven ru.onlinesim:onlinesim-kotlin |
Dokumentation |
| C# / .NET | NuGet OnlineSim.Api |
Dokumentation |
| Ruby | RubyGems onlinesim |
Dokumentation |
| Dart / Flutter | pub.dev onlinesim |
Dokumentation |
| Swift | SwiftPM https://github.com/s00d/onlinesim-swift-api |
Dokumentation |
Fehler
Ein Fehler ist ein JSON-Objekt mit dem Fehlercode in response:
{
"response": "ERROR_CODE"
}Fehler kommen mit HTTP-Status 200, außer zweien: 456 bei einem ungültigen API-Schlüssel oder abgelaufenen OAuth-Token und 429, wenn das Anfragelimit überschritten ist. Jede Methode führt ihre eigenen Codes auf; die folgenden Codes kann jede Methode liefern.
Verarbeitungsregeln
- Codeformat — UPPER_SNAKE_CASE (einzige Ausnahme ist der OAuth-Scope-Fehler unten)
- Die Liste der Codes ist nicht geschlossen — sie kann erweitert werden
- Ein unbekannter Code sollte als allgemeiner Fehler behandelt und zur Untersuchung protokolliert werden
| Code | HTTP | Beschreibung |
|---|---|---|
ERROR_WRONG_KEY |
456 | Ungültiger API-Schlüssel oder abgelaufenes OAuth-Token. Auch öffentliche Methoden liefern ihn, wenn ein ungültiger Schlüssel übergeben wird |
ERROR_WRONG_KEY |
200 | Kein Schlüssel in einer Anfrage an eine Methode, die einen braucht |
ACCOUNT_BLOCKED |
200 | Das Konto ist gesperrt, wenden Sie sich an den Support |
ACCOUNT_CLEANED |
200 | Das Konto wurde gelöscht |
USER_NOT_ACTIVATED |
200 | Die E-Mail des Kontos ist nicht bestätigt |
API_ACCESS_DISABLED |
200 | API-Zugriff ist in den Profileinstellungen deaktiviert (der Schalter API enthalten ist inaktiv) |
API_ACCESS_IP |
200 | Die IP-Adresse ist nicht in der Allowlist (siehe Zugriff von IP) |
Invalid scope(s) provided: <scope> |
200 | Das OAuth-Token wurde ohne den Scope ausgestellt, den die Methode braucht |
TRY_AGAIN_LATER |
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 |
TRY_AGAIN_LATER |
200 | Unerwarteter Fehler, wiederholen Sie die Anfrage später |
Nutzungsbedingungen:https://onlinesim.io/documentation/offer
Kontakt
- E-Mail:support@onlinesim.io
- URL:https://onlinesim.io
Lizenz
Server
https://onlinesim.io
Onlinesim-Server