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

GET /api/rent/closeRentNum.php

Mietvorgang für virtuelle Nummer abschließen

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

Sicherheit

apikey

BearerAuth

OAuth2Berechtigungen: rent-scope

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

Parameter

query2

Name	Typ	Beschreibung
`tzid`*	`string`	Vorgangs-ID, die vom Server bei der Ausgabe einer Nummer zurückgegeben wird (als Antwort auf eine getNum- oder getRentNum-Anfrage). Die Liste der aktiven Vorgänge Ihres Profils mit ihren IDs kann auch über getState oder getRentState abgerufen werden
`lang`	`string`	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:`frderuenzh`Standard:`ru`

Antworten

200

Erfolgreiche Antwort auf die Anfrage closeRentNum: Der Server schließt den aktuellen Mietvorgang und gibt Informationen darüber zurück oder wirft eine Ausnahme

Content-Typeapplication/json

Schema

ResponseoneOf

Erfolgreiches Schließen des Mietvorgangs, spezifischer oder allgemeiner Fehler

Eins von

[0]object

responsestringErforderlich

"1" — der Mietvorgang wurde erfolgreich geschlossen. Es wird nur der Status zurückgegeben; Nummer, SMS und Guthaben sind nicht enthalten

Enumeration:1

[1]object

responsestringErforderlich

Methodenspezifischer Fehlercode:

ERROR_NO_OPERATIONS — keine aktive Miete mit dieser tzid für dieses Konto
NO_COMPLETE_TZID — Schließung während des Schutzintervalls nicht verfügbar: solange keine SMS vorhanden ist und 120 Sekunden seit dem Start nicht vergangen sind (die Miete wartet noch auf Aktivierung); wird auch immer zurückgegeben, wenn versucht wird, eine US-Mietnummer zu schließen
TRY_AGAIN_LATER — Schließung fehlgeschlagen, versuchen Sie die Anfrage später erneut

Enumeration:ERROR_NO_OPERATIONSNO_COMPLETE_TZIDTRY_AGAIN_LATER

[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

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

Schließung während des Schutzintervalls nicht verfügbar: solange keine SMS vorhanden ist und 120 Sekunden seit dem Start nicht vergangen sind (die Miete wartet noch auf Aktivierung); wird auch immer zurückgegeben, wenn versucht wird, eine US-Mietnummer zu schließen

{
  "response": "NO_COMPLETE_TZID"
}

Codebeispiele

Beispiele werden generiert...