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

GET /api/getNum.php

Virtuelle Nummer für den ausgewählten Dienst kaufen

Fordert eine Nummer zum Empfang von SMS vom ausgewählten Dienst an.

Ermöglicht es, eine Nummer des ausgewählten Landes zum Empfang einer SMS-Nachricht von einer bestimmten Website/Anwendung zu bestellen.

Im Wesentlichen ist es ein Analogon zur Schaltfläche zum Kauf einer Nummer, die sich im persönlichen Konto befindet.

Sicherheit

apikey
BearerAuth
OAuth2Berechtigungen: sms-scope
sms-scope
grants access to manage numbers for the SMS receiving service from Onlinesim

Parameter

query6
NameTypBeschreibung
service*string

Servicenamen gemäß der Dienstliste

country*string

Ländercode (gemäß Länderliste)

rejectstring[]
dev_idinteger

ID des Kontos für Softwareentwickler (ID des Onlinesim-Profils)

numberboolean

Flag zur Anzeige detaillierter Informationen über den Vorgang in der Serverantwort. Wenn der Wert true übergeben wird, gibt die Anfrage die Nummer des bestellten Telefons in der Antwort zurück sowie eine Reihe zusätzlicher Referenzfelder

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 auf die Anfrage getNum: Der Server gibt eine virtuelle Nummer für den Empfang von SMS vom angegebenen Dienst aus oder wirft eine Ausnahme

Content-Typeapplication/json
Schema
ResponseoneOf
Eins von
[0]allOf
Alles von
[0]object
responseintegerErforderlich

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

Enumeration:1
tzidintegerErforderlich

Vorgangs-ID

≥ 1
[1]object
numberstringErforderlich

Telefonnummer im internationalen Format mit + (z. B. +373…)

countryintegerErforderlich

Ländercode ohne + (entspricht dem Wert in der Anfrage: 7, 46, 373…)

timeintegerErforderlich

Sekunden bis zum Ablauf des Vorgangs (wie lange die Nummer aktiv bleibt)

≥ 0
servicestringErforderlich

Dienst-Slug (z. B. telegram, whatsapp)

titlestringErforderlich

Menschenlesbarer Dienstname (Sprache wird durch lang festgelegt)

response_textstringErforderlich

Statustext des Vorgangs in der durch lang festgelegten Sprache (unmittelbar nach der Ausgabe normalerweise „Warten auf SMS“)

guard_interval_remaining_secondsintegerErforderlich

Sekunden bis zum erlaubten vorzeitigen Schließen ohne SMS (0 — bereits erlaubt). Normalerweise 120 s; für WhatsApp — 300 s

≥ 0
[1]object
responseintegerErforderlich

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

Enumeration:1
tzidintegerErforderlich

Vorgangs-ID

≥ 1
[2]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

Successful getNum response

Erfolgreiche Nummernausgabe

{
  "response": 1,
  "tzid": 10000
}

Codebeispiele

Beispiele werden generiert...