v1

Aktuellen Vorgang abschließen

POST{yourserver}/finishActivation

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

Standardmäßig wird diese Anfrage nach Ablauf der Vorgangszeit gesendet. Sie kann auch früher gesendet werden, wenn der Kunde den Vorgang schließt: nachdem die SMS empfangen wurde oder um ihn ohne SMS abzubrechen.

Der Status 1 wird anstelle von 4 gesendet, wenn die Nummer in drei (oder mehr) Vorgängen Ihrer Integration, einschließlich dieses Vorgangs, keine SMS von diesem Dienst empfangen konnte oder wenn der Kunde die Nummer als nicht funktionierend meldet. Er ist ein Signal dafür, dass das Paar "Nummer + Dienst" höchstwahrscheinlich erneut fehlschlagen wird: Sie können ihn verwenden, um das Paar von der Ausgabe auszuschließen, oder ihn ignorieren.

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
Vorgangs-ID (wird von Ihrem Server in GET_NUMBER zugewiesen)≥ 1Beispiel:355
sumnumber
Betrag, der Ihrem Guthaben für den Vorgang gutgeschrieben wird, in Rubel. Wird nur von einigen Integrationen gesendetBeispiel:4.5
statusintegerErforderlich
Statuscode des Vorgangs: 1 - keine SMS empfangen, und die Nummer konnte in drei (oder mehr) Vorgängen keine SMS von diesem Dienst empfangen, oder der Kunde hat sie als nicht funktionierend gemeldet. Überprüfen Sie Nummer und Dienst, es kann sinnvoll sein, das Paar von der Ausgabe auszuschließen 3 - erfolgreich verkauft (eine SMS wurde empfangen) 4 - abgebrochen, keine SMS wurde empfangenEnumeration:134Beispiel:3
keystringErforderlich
API-Schlüssel Ihres OnlineSIM-PartnerprofilsBeispiel:apikey

Beispiele

sold

Schließen eines verkauften Vorgangs

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75489,
  "status": 3,
  "key": "apikey"
}
cancelled

Schließen eines Vorgangs ohne SMS

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75490,
  "status": 4,
  "key": "apikey"
}

Antworten

200Die Antwort Ihres Servers auf FINISH_ACTIVATION. 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 - der Vorgang 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 Vorgang ist geschlossen

{
  "status": "SUCCESS"
}
recordNotFound

Unbekannter Vorgang (für die Status 3 und 4 als geschlossen akzeptiert)

{
  "status": "ERROR",
  "error": "record not found"
}

Codebeispiele

Beispiele werden generiert...