v1

Virtuelle Nummer für den angegebenen Dienst bestellen

POST{yourserver}/getNumber

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

Diese Anfrage wird an Ihren Server gesendet, wenn ein Kunde eine Nummer bestellt, um für einen kurzen Zeitraum SMS von einem Dienst zu empfangen (standardmäßig 15 Minuten; der Zeitraum hängt vom Dienst ab).

Der Vorgang kann vorzeitig geschlossen werden (siehe FINISH_ACTIVATION).

Anforderungs-Body

Anfragetext vom OnlineSIM-Server

Content-Typeapplication/json
Schema
schemaobject
actionstringErforderlich
Name der Methode, in diesem Fall GET_NUMBEREnumeration:GET_NUMBERBeispiel:GET_NUMBER
countrystringErforderlich
Name des Landes aus der Liste der LänderBeispiel:germany
operatorstringErforderlich
Name des Betreibers: any, wenn Ihre GET_SERVICES-Antwort den Betreiber any enthält, andernfalls einer der Betreiber, die Sie für das Land angegeben habenBeispiel:any
servicestringErforderlich
Name des Dienstes aus der Liste der Dienste (ein Wert von services, z. B. fb)Beispiel:fb
sumnumberErforderlich
Ihr Einkommen für den Vorgang, in Rubel: wird Ihrem OnlineSIM-Konto gutgeschrieben, wenn der Vorgang mit empfangener SMS geschlossen wirdBeispiel:40
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey

Beispiele

request

GET_NUMBER-Anfrage vom OnlineSIM-Server

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

Antworten

200Die Antwort Ihres Servers auf GET_NUMBER
Content-Typeapplication/json
Schema
schemaobject
numberinteger | string
Erforderlich bei SUCCESS. Ausgegebene Telefonnummer im internationalen Format mit Landesvorwahl, nur Ziffern (eine JSON-Zahl oder eine Ziffernfolge als String)Beispiel:79088081050
activationIdinteger
Erforderlich bei SUCCESS. Von Ihrem Server zugewiesene Vorgangs-ID; OnlineSIM liest sie als Ganzzahl und sendet sie in FINISH_ACTIVATION zurück≥ 1Beispiel:355
statusstringErforderlich
Status der Anfrage:
  • SUCCESS - die Nummer ist ausgegeben;
  • NO_NUMBERS - keine verfügbaren Nummern;
  • jeder andere Wert (z. B. ERROR) - ein Fehler.
Bei allem außer SUCCESS versucht OnlineSIM den nächsten Partner.
Enumeration:SUCCESSNO_NUMBERSERRORBeispiel:SUCCESS

Beispiele

success

Die Nummer ist ausgegeben

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

Keine verfügbaren Nummern

{
  "status": "NO_NUMBERS"
}
error

Jeder andere Fehler

{
  "status": "ERROR"
}

Codebeispiele

Beispiele werden generiert...