Alternative API
Version: 1.0
Allgemeine Beschreibung
Alternative API für die Integration mit Onlinesim.
Diese API ermöglicht Ihnen den Zugang zu zwei Hauptdiensten von Onlinesim: der Vermietung von Nummern zum Empfang von SMS von einer Vielzahl verschiedener Absender (einschließlich von anderen Mobiltelefonnummern) sowie dem Empfang von SMS von einem ausgewählten Dienst.
WARNING
Diese API ist nur für registrierte Onlinesim-Benutzer verfügbar!
Sie müssen ein Onlinesim-Profil registrieren, um auf diese API zugreifen zu können. In dieser Dokumentation verwenden wir zur Vereinfachung die API-Schlüssel-Authentifizierung, jedoch sind auch andere Methoden verfügbar (mehr Informationen zu verfügbaren Authentifizierungsmethoden finden Sie im Abschnitt Authentifizierung).
INFO
Der Empfang von Nachrichten von Zahlungssystemen, Banken und anderen Kreditinstituten ist auf unserer Plattform nicht verfügbar. Für weitere Informationen, einschließlich einer Liste solcher Dienste, lesen Sie bitte die Öffentliche Offerte.
Liste der Anfragen
Die 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 beide von Onlinesim bereitgestellten Dienste gleichzeitig
- getBalance - gibt das aktuelle verfügbare Guthaben Ihres Profils zurück;
- getCountries - gibt eine Liste der Länder und allgemeine Informationen zu verfügbaren Diensten zurück.
Abschnitt "SMS-Empfang"
Der Dienst 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.
- getNumbersStatus - fragt die Anzahl der verfügbaren Nummern ab, gruppiert nach Ländern und Diensten;
- getNumber - bestellt eine Nummer des ausgewählten Landes zum Empfang von SMS vom angegebenen Dienst;
- getStatus - fragt eine Liste der Codes aus empfangenen SMS ab;
- getFullSms - fragt eine Liste der empfangenen SMS mit vollständigem Text von der angegebenen Nummer ab;
- setStatus - ändert den Status des Vorgangs (storniert die Bestellung, schließt den Vorgang usw.)
Abschnitt "Vermietung"
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 der verbotenen.
- getRentServicesAndCountries - fragt eine Liste der Länder mit verfügbaren Mietnummern ab;
- getRentNumber - mietet eine Nummer des ausgewählten Landes für den angegebenen Zeitraum;
- getRentList - gibt eine Liste der Nummern Ihres Profils mit aktiver Vermietung zurück;
- getRentStatus - gibt Informationen über den aktuellen Status der Mietnummer sowie eine Liste der empfangenen Nachrichten zurück;
- setRentStatus - schließt den Mietvorgang.
Die Sammlung von Anfragen für Postman ist hier verfügbar:
Jede Anfrage enthält eine eigene Beschreibung, den Typ, die Endpoint-URL, Parameter sowie Beispiele für den Request- und Response-Body. In der Beschreibung einzelner Anfragen kann außerdem eine Liste spezifischer Fehler angegeben sein, die als Antwort zurückgegeben werden können und bei der Ausführung dieser Methoden auftreten können. Die Antworten werden je nach aufgerufenem Methodentyp und Ergebnis im JSON- oder TXT-Format bereitgestellt.
Fehlerbehandlung
Allgemeine Ausnahmen für die Methoden werden im TXT-Format zurückgegeben.
TEXT_ERROR
| TEXT_ERROR | Beschreibung |
|---|---|
BAD_KEY | Der API-Schlüssel ist ungültig oder fehlt |
BAD_ACTION | Nicht behandelte Ausnahme |
Terms of Service: https://onlinesim.io/documentation/offer
Kontakt
- Name: Artem
- Email: [email protected]
- URL: https://onlinesim.io
Lizenz
GNU General Public License, version 3.0
Server
http://api-conserver.onlinesim.io
Onlinesim Server