rent

Mietvorgang für virtuelle Nummer abschließen

GEThttps://onlinesim.io/api/rent/closeRentNum.php

Diese Anfrage schließt den angegebenen Mietvorgang (mit Ausnahme der Miete von US-Nummern – diese kann ausschließlich bei Ablauf der Vorgangsfrist geschlossen werden).

Eine Miete, die auf die erste SMS wartet (status 0), kann 120 Sekunden nach dem Start oder sofort nach einer beliebigen SMS geschlossen werden; ihre Reservierung wird aufgehoben. Ein Hinweis auf einen verbotenen Absender (service notify) bestätigt die Miete nicht, daher wird auch eine solche Miete mit aufgehobener Reservierung geschlossen. Eine bestätigte Miete wird ohne Rückerstattung geschlossen. Ist eine echte SMS eingegangen, hat die Miete aber noch status 0, wird die Miete bestätigt (der Preis wird abgebucht, ohne Rückerstattung) und geschlossen; die Antwort ist "1". POST mit denselben Parametern funktioniert ebenfalls.

Sicherheit

OAuth2
rent-scope
grants access to renting phone numbers from Onlinesim

Parameter

query2
NameTypBeschreibung
tzid*integer

ID des Mietvorgangs. Ohne sie lautet die Antwort ERROR_NO_OPERATIONS

langstring

Sprache der Texte in der Antwort (Länder- und Dienstnamen, Statustexte): fr, de, ru, en oder zh. Jede Methode akzeptiert ihn; Methoden ohne solche Texte antworten in jeder Sprache gleich. Feldnamen, Fehlercodes und andere feste Werte bleiben auf Englisch. Ohne den Parameter: ru für getTariffs, getNumbersStats und getFreeList; sonst die Sprache des Profils bei Anfragen mit Schlüssel, Englisch bei Anfragen ohne. Ein nicht unterstützter Wert wird durch die Standardsprache ersetzt

Enumeration:frderuenzh

Antworten

200"1" oder ein Fehler
Content-Typeapplication/json
Schema
schemaoneOf
Eins von
[0]object
[1]object
[2]object

Beispiele

Rental operation successfully closed

Erfolgreiches Schließen des Mietvorgangs

{
  "response": "1"
}
No active rental operations

Keine aktiven Mietvorgänge

{
  "response": "ERROR_NO_OPERATIONS"
}
Unable to close the specified rental operation

Die Miete wartet auf die erste SMS und seit dem Start sind keine 120 Sekunden vergangen

{
  "response": "NO_COMPLETE_TZID"
}
US number

Eine US-Nummer kann nicht vorzeitig geschlossen werden

{
  "response": "NO_CLOSE_RENT_US"
}
429HTTP 429: mehr als 400 Anfragen pro Minute von einem Profil (von einer IP bei Anfragen ohne Schlüssel) oder mehr als 200 Anfragen pro Minute von einem Profil an getNum, getPrice, getState und setOperationOk zusammen
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Rate limit

Anfragelimit überschritten

{
  "response": "TRY_AGAIN_LATER"
}
456HTTP 456: Der API-Schlüssel ist ungültig oder das OAuth-Token ist abgelaufen. Öffentliche Methoden antworten genauso, wenn ein ungültiger Schlüssel übergeben wird
Content-Typeapplication/json
Schema
schemaobject
responsestringErforderlich
Fehlercode. Die Codes, die jede Methode liefern kann, stehen in der Einleitung; jede Methode führt ihre eigenen auf. Die Liste ist nicht geschlossen: behandeln Sie einen unbekannten Code als allgemeinen Fehler und protokollieren Sie ihn.

Beispiele

Invalid key

Ungültiger API-Schlüssel oder abgelaufenes Token

{
  "response": "ERROR_WRONG_KEY"
}

Codebeispiele

Beispiele werden generiert...