v1 rent

Mietvorgang einer virtuellen Nummer abschließen

POST{yourserver}/finishActivationRent

Diese Anfrage wird vom OnlineSIM-Server gesendet, um den aktuellen Mietvorgang mit einem Status zu schließen, der von seinem Ergebnis abhängt.

Standardmäßig wird diese Anfrage nach Ablauf der Miete gesendet. Sie kann auch früher gesendet werden:

  1. wenn der Kunde die Miete vorzeitig beendet;
  2. wenn während der Wartezeit nach der Erstellung des Vorgangs keine SMS empfangen wurde (standardmäßig 20 Minuten, abhängig von der Integration) - mit dem Status 4.

Anforderungs-Body

Anfragetext vom OnlineSIM-Server

Content-Typeapplication/json
Schema
schemaobject
actionstringErforderlich
Name der Methode, in diesem Fall FINISH_ACTIVATIONEnumeration:FINISH_ACTIVATIONBeispiel:FINISH_ACTIVATION
activationIdintegerErforderlich
ID des Vorgangs (wird von Ihrem Server in GET_NUMBER zugewiesen)≥ 1Beispiel:355
statusintegerErforderlich
Statuscode des Vorgangs: 3 - die Miete wurde genutzt (eine SMS wurde empfangen) 4 - abgebrochen, keine SMS wurde empfangen 1 - wird von einigen Integrationen anstelle von 4 gesendet, wenn die Nummer mehrmals keine SMS empfangen konnteEnumeration:134Beispiel:3
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey
sumnumber
Ihr Einkommen für die gesamte Miete (Anfangszeitraum plus alle Verlängerungen), in Rubel; wird Ihrem OnlineSIM-Konto beim Schließen der Miete gutgeschriebenBeispiel:870

Beispiele

used

Schließen eines genutzten Mietvorgangs

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75491,
  "status": 3,
  "key": "apikey",
  "sum": 2408
}

Antworten

200Die Antwort Ihres Servers auf FINISH_ACTIVATION (für die Miete). Nur status: SUCCESS schließt den Vorgang; für die Status 3 und 4 wird auch die Antwort {"status": "ERROR", "error": "record not found"} als geschlossen akzeptiert.
Content-Typeapplication/json
Schema
schemaobject
statusstringErforderlich
SUCCESS - die Miete ist auf Ihrer Seite geschlossen; jeder andere Wert - die Anfrage wird wiederholtEnumeration:SUCCESSERRORBeispiel:SUCCESS
errorstring
Fehlertext. record not found (unbekannte activationId) wird für die Status 3 und 4 als geschlossen akzeptiertBeispiel:record not found

Beispiele

success

Der Mietvorgang ist auf Ihrem Server geschlossen

{
  "status": "SUCCESS"
}

Codebeispiele

Beispiele werden generiert...