post{yourserver}/finishActivationRent

POST /finishActivationRent

Mietvorgang einer virtuellen Nummer abschließen

Diese Anfrage wird vom Onlinesim-Server gesendet, um den aktuellen Mietvorgang mit einem bestimmten Status zu schließen (der von den Ergebnissen des Vorgangs abhängt).

Standardmäßig wird diese Anfrage nach Ablauf der Vorgangszeit gesendet. Die Anfrage kann auch vorzeitig in einem von zwei Fällen gesendet werden:

  1. wenn die SMS vom bestellten Dienst erfolgreich empfangen wurde und der Kunde den Mietvorgang vorzeitig schließt;
  2. wenn die SMS vom bestellten Dienst nicht empfangen wurde und der Vorgang nach Ablauf des Schutzintervalls (20 Minuten ab Erstellung) geschlossen wird

Der Empfang einer Anfrage mit dem Status 1 ist ein Signal dafür, dass die Nummer aus irgendeinem Grund innerhalb von drei (oder mehr) Vorgängen keine SMS vom bestellten Dienst empfangen konnte. Sie können diesen Status als Indikator für die Notwendigkeit der Überprüfung der Nummer verwenden und sie in Zukunft von der Ausgabe ausschließen oder ihn ignorieren.

Parameter

header1
NameTypBeschreibung
Authorization*string

Siehe Details hier

Anforderungs-Body

Anfragetext vom Onlinesim-Server

Content-Typeapplication/json
Schema
Bodyobject
actionstringErforderlich

Name der Methode, in diesem Fall FINISH_ACTIVATION

Enumeration:FINISH_ACTIVATIONStandard:FINISH_ACTIVATION
activationIdintegerErforderlich

ID des Vorgangs (wird von Ihrem Server zugewiesen)

≥ 1
statusintegerErforderlich

Statuscode des Vorgangs, enum:

1 - Nummer konnte innerhalb von drei (oder mehr) Mietvorgängen keine SMS empfangen. Überprüfen Sie, ob es Probleme mit dieser Nummer gibt, möglicherweise sollten Sie sie in Zukunft von der Ausgabe ausschließen

3 - Vorgang erfolgreich abgeschlossen

4 - Vorgang wurde abgebrochen, Nachricht wurde nicht empfangen

5 - Für den Vorgang wurde eine Rückerstattung durchgeführt, bei Fehlern und Problemen mit der Nachricht.

Enumeration:134
keystringErforderlich

API-Schlüssel Ihres Onlinesim-Partnerprofils

servicestringErforderlich

Name des Dienstes. Für Miete immer rent

Enumeration:rent
sumnumber

Gesamtkosten der Miete einschließlich aller Verlängerungsperioden in Rubel (dieser Betrag wird Ihrem Onlinesim-Partnerkonto bei erfolgreichem Abschluss des Mietvorgangs gutgeschrieben)

Beispiele

Example payload of Onlinesim server FINISH_ACTIVATION request (for closing rent operation)
{
  "action": "FINISH_ACTIVATION",
  "activationId": 75491,
  "status": 3,
  "key": "apikey",
  "service": "rent",
  "sum": 2408
}

Antworten

200

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

Content-Typeapplication/json
Schema
Responseobject
statusstring

Status der Anfrageausführung (SUCCESS oder ERROR)

Enumeration:SUCCESSERROR

Beispiele

Response example from your server (when the rental operation was successfuly closed on your server)
{
  "status": "SUCCESS"
}

Codebeispiele

Beispiele werden generiert...