Komponenten
Schemas
CountryListSchema
Liste der Länder mit den jeweiligen verfügbaren Nummernanzahlen pro Betreiber und Dienst
Typ: array
V1GetNumberResponse
Typ: object
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
number |
integer |
✓ | Telefonnummer im internationalen Format gemäß den in der Anfrage angegebenen Parametern |
activationId |
integer |
✓ | Vorgangs-ID (wird von Ihrem Server zugewiesen) |
status |
string |
✓ | Status der Anfrageausführung (SUCCESS - bei erfolgreicher Nummernausgabe, NO_NUMBERS - wenn keine verfügbaren Nummern vorhanden sind, ERROR - bei anderen Fehlern) |
NumberInfo
Ein Objekt mit Daten zu jeder Nummer, wobei der Schlüssel die Telefonnummer ist
Typ: object
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id |
integer |
Nummern-ID | |
balance |
integer |
Guthaben der Nummer | |
country_id |
integer |
Ländercode (gemäß Länderliste) | |
errors |
integer |
Wie oft die Nummer bestellt wurde, aber keine SMS erhalten konnte (Anzahl fehlgeschlagener Vorgänge) | |
number |
string |
Telefonnummer im internationalen Format | |
port_id |
string |
Eindeutiger Portname, der in unserer Benutzeroberfläche auf der Seite zur Verwaltung Ihrer Nummern angezeigt wird. Der Standardwert entspricht der Telefonnummer (dem Wert des Parameters number) |
|
sum |
integer |
Gesamteinkommen, das von dieser Nummer erzielt wurde, in Rubel | |
used_service |
object |
Ein Objekt, dessen Schlüssel die Kurznamen (Slugs) der auf der aktuellen Nummer verwendeten Dienste sind, gemäß der Dienste-Liste. Für den Dienst „Miete“ lautet der Schlüssel rent |
|
banned_service |
object |
Ein Objekt, dessen Schlüssel die Kurznamen (Slugs) der auf der aktuellen Nummer gesperrten Dienste sind, gemäß der Dienste-Liste. Für den Dienst „Miete“ lautet der Schlüssel rent | |
history |
object[] |
||
banned |
boolean |
Wenn true, ist die Nummer blockiert (die Blockierung wird automatisch nach 3 fehlgeschlagenen Vorgängen angewendet). Die Blockierung wird automatisch alle 24 Stunden aufgehoben oder durch Klicken auf die Schaltfläche Bans zurücksetzen/Clean all banned services auf der PSA-Seite. |
|
reseller_id |
integer |
ID des Onlinesim-Partnerkontos | |
rent |
boolean |
Wenn der Wert true ist, hat Ihr Konto die Möglichkeit, Nummern zur Miete anzubieten |
|
status |
integer |
Aktueller Status der Nummer, enum: 1 - Nummer funktioniert 2 - Nummer wird auf den Server geladen (nach dem Hinzufügen zur Nummernliste) 3 - (deprecated) 4 - Die von Ihnen angegebene Nummer ist nicht in Ihrem Konto vorhanden (ungültige Nummer) 5 - (deprecated) 6 - null, Mietfehler: Diese Nummer wurde zuvor erfolgreich für die Miete verwendet und wird keinen Gewinn mehr generieren. Sie müssen die Nummer durch eine neue ersetzen. 7 - (deprecated) |
|
status_text |
string |
Aktueller Status der Nummer, Textbeschreibung | |
clearable |
boolean |
Verfügbarkeit der Funktion Bans zurücksetzen/Clean all banned services (verfügbar einmal alle 24 Stunden) |
|
created_at |
object |
NumberItem
Typ: object
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
number |
string |
✓ | Telefonnummer im internationalen Format |
country_id |
integer |
✓ | Ländercode (laut Länderliste) |
operator |
integer |
MCC + MNC-Codes des Betreibers (diese Codes sind in den ersten 5 Ziffern der IMSI enthalten) | |
date_start |
integer<date-time> |
Datum und Uhrzeit der Platzierung der Telefonnummer im UNIX-Timestamp-Format | |
port_id |
string |
Eindeutiger Portname, der in unserer Benutzeroberfläche auf der Seite zur Verwaltung Ihrer Nummern angezeigt wird. Der Standardwert entspricht der Telefonnummer (dem Wert des Parameters number) | |
used |
string[] |
||
rent |
integer |
✓ | Mietmodus für diese Nummer: 1 - aktiviert, 0 - deaktiviert, |
MessageItem
Typ: object
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
number |
integer | string |
✓ | Telefonnummer im internationalen Format oder Nummern-ID (siehe Serverantwort auf die Anfrage sendNumbersOnline) |
from |
string |
✓ | Name oder Nummer des Absenders |
message |
string |
✓ | Nachrichtentext |
date |
string |
Datum und Uhrzeit des Nachrichtenempfangs (in jedem Format, z. B. UNIX-Zeitstempel) |
test
Optionales Feld für den Anfragetext der Reseller API v2. Kann einen von zwei Werten annehmen: test1 oder test2.
Bei Wert test1 wird die Anfrage an den Server gesendet, aber die mit dieser Anfrage übermittelten Daten werden von unserem Server nicht gespeichert (die Funktion wird nicht durch diese Anfrage ausgeführt).
Wenn der Parameter test2 ist, gibt der Onlinesim-Server in der Antwort den Textkörper Ihrer Anfrage zurück.
Kann als Query-Parameter (für GET) oder als Feld im Anfragetext (für POST) übergeben werden. Beide Methoden sind gleichwertig, aber die gleichzeitige Verwendung wird nicht empfohlen.
Typ: string
Enumeration: test1, test2
Parameter
header2
| Name | Typ | Beschreibung |
|---|---|---|
Authorization* | string | Siehe Details hier |
Content-Type* | string | Header Enumeration: application/json; charset=utf-8 |
query1
| Name | Typ | Beschreibung |
|---|---|---|
test | string | Optionales Feld für den Anfragetext der Reseller API v2. Kann einen von zwei Werten annehmen: Bei Wert Wenn der Parameter Kann als Query-Parameter (für GET) oder als Feld im Anfragetext (für POST) übergeben werden. Beide Methoden sind gleichwertig, aber es wird nicht empfohlen, sie gleichzeitig zu verwenden. Enumeration: test1test2 |
Antworten
WrongKeyResponseNicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet
Nicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet
application/jsonResponseobject
Detailed403ErrorResponseVerboten. Die Anfrage wurde verstanden, aber aufgrund fehlender Berechtigungen abgelehnt
Verboten. Die Anfrage wurde verstanden, aber aufgrund fehlender Berechtigungen abgelehnt
application/jsonResponseobject
errorobjectErforderlich
detailsobject[]Erforderlich
UnauthorizedNicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet. Einige Endpunkte können anstelle von 401 einen 200-Status mit der Meldung ERROR_WRONG_KEY zurückgeben — prüfen Sie den Antworttext
Nicht autorisiert. Der Anfrage fehlt der API-Schlüssel oder es wurde ein ungültiger API-Schlüssel verwendet. Einige Endpunkte können anstelle von 401 einen 200-Status mit der Meldung ERROR_WRONG_KEY zurückgeben — prüfen Sie den Antworttext
text/plainErrorParamsErforderliche Parameter fehlen oder sind inkorrekt (der Anfragetext muss die Parameter mit den korrekten Bezeichnungen enthalten, wie in der Dokumentation angegeben)
Erforderliche Parameter fehlen oder sind inkorrekt (der Anfragetext muss die Parameter mit den korrekten Bezeichnungen enthalten, wie in der Dokumentation angegeben)
application/json