v1 rent

Mieten einer virtuellen Telefonnummer bestellen

POST{yourserver}/getNumberRent

Diese Anfrage erstellt einen neuen Mietvorgang, der es dem Kunden ermöglicht, eine Nummer für den Empfang von SMS von beliebigen Diensten und anderen Mobilnummern über einen längeren Zeitraum (von 1 Tag bis zu mehreren Monaten) zu verwenden.

Wenn die Nummer innerhalb von 20 Minuten nach Erstellung des Vorgangs keine SMS empfängt, wird der Vorgang standardmäßig automatisch mit dem Status 4 geschlossen und die Nummer wird für einen anderen Vorgang verfügbar (die Wartezeit hängt von der Integration ab).

Die Miete kann vom Kunden verlängert werden. Verlängerungen werden Ihnen nicht als separate Anfragen gesendet: Das Einkommen für die gesamte Miete wird BEIM SCHLIESSEN DES VORGANGS GUTGESCHRIEBEN (bei Ablauf oder Beendigung der Miete) und als sum in FINISH_ACTIVATION übergeben.

Anforderungs-Body

Anfragetext vom OnlineSIM-Server für einen Mietvorgang

Content-Typeapplication/json
Schema
schemaobject
actionstringErforderlich
Name der Methode, in diesem Fall GET_NUMBEREnumeration:GET_NUMBERBeispiel:GET_NUMBER
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey
countrystringErforderlich
Name des Landes aus der Liste der LänderBeispiel:germany
operatorstringErforderlich
Name des Betreibers, für die Miete immer anyEnumeration:anyBeispiel:any
servicestringErforderlich
Mietart: rent - eine Miete, die der Kunde verlängern kann, rent_noext - eine Miete ohne Verlängerung. Bei Integrationen, die die Miete pro Zeitraum bestellen, wird der Zeitraum in Tagen angehängt (rent7, rent_noext30); andernfalls wird der Zeitraum nicht übergebenBeispiel:rent
sumnumberErforderlich
Ihr Einkommen für den Anfangszeitraum der Miete, in RubelBeispiel:320

Beispiele

request

GET_NUMBER-Anfrage vom OnlineSIM-Server (für die Miete)

{
  "action": "GET_NUMBER",
  "key": "apikey",
  "country": "germany",
  "operator": "any",
  "service": "rent",
  "sum": 400
}

Antworten

200Die Antwort Ihres Servers auf GET_NUMBER (für die Miete)
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 zur Miete 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...