post{yourserver}/getNumber

POST /getNumber

Virtuelle Nummer für den angegebenen Dienst bestellen

Anfrage zur Bestellung einer Nummer für den Empfang von SMS vom angegebenen Dienst.

Diese Anfrage wird an Ihren Server gesendet, um eine Nummer mit bestimmten Parametern für den Empfang von SMS von einem einzelnen Dienst für einen kurzen Zeitraum (standardmäßig 15 Minuten) zu bestellen.

Der Vorgang kann vorzeitig geschlossen werden (siehe FINISH_ACTIVATION).

Parameter

header2

Name	Typ	Beschreibung
`Authorization`*	`string`	Siehe Details hier
`Content-Type`*	`string`	Header `Content-Type` und Kodierung Enumeration:`application/json; charset=utf-8`

Anforderungs-Body

Anfragetext vom Onlinesim-Server

Content-Typeapplication/json

Schema

Bodyobject

actionstringErforderlich

Name der Methode, in diesem Fall GET_NUMBER

Enumeration:GET_NUMBERStandard:GET_NUMBER

countrystringErforderlich

Name des Landes, enum (siehe Liste der Länder)

operatorstringErforderlich

Name des Betreibers (für Beispiele siehe Liste der Betreiber)

servicestringErforderlich

Name des Dienstes, enum (siehe Liste der Dienste)

sumnumberErforderlich

Preis des Dienstes in Rubel (dieser Betrag wird auf Ihr Onlinesim-Partnerkonto gutgeschrieben, wenn der Vorgang erfolgreich abgeschlossen wird)

keystringErforderlich

API-Schlüssel Ihres Onlinesim-Partnerprofils

exceptionPhoneSetinteger[]

Liste der Ausnahmepräfixe für Nummernmasks, die NICHT bei der Nummernanfrage ausgegeben werden sollen. Format: Ländercode + darauf folgende Nummerziffern.

itemsinteger

Beispiele

Example payload of Onlinesim server GET_NUMBER request

{
  "action": "GET_NUMBER",
  "country": "russia",
  "operator": "any",
  "service": "vk",
  "sum": 40,
  "key": "apikey"
}

Antworten

200

Die Antwort Ihres Servers auf die Anfrage GET_NUMBER muss im folgenden Format sein:

Content-Typeapplication/json

Header

Name	Typ	Beschreibung
`Content-Type`	`string`	Header `Content type` und Codierung

Schema

Responseobject

numberintegerErforderlich

Telefonnummer im internationalen Format gemäß den in der Anfrage angegebenen Parametern

activationIdintegerErforderlich

Vorgangs-ID (wird von Ihrem Server zugewiesen)

≥ 1

statusstringErforderlich

Status der Anfrageausführung (SUCCESS - bei erfolgreicher Nummernausgabe, NO_NUMBERS - wenn keine verfügbaren Nummern vorhanden sind, ERROR - bei anderen Fehlern)

Enumeration:SUCCESSNO_NUMBERSERROR

Beispiele

Successful response example from your server

{
  "number": 79281234567,
  "activationId": 355,
  "status": "SUCCESS"
}

No available numbers response example from your server

{
  "number": null,
  "activationId": null,
  "status": "NO_NUMBERS"
}

Response example from your server in case of other types of errors

{
  "number": null,
  "activationId": null,
  "status": "ERROR"
}

Codebeispiele

Beispiele werden generiert...