post FINISH_ACTIVATION

https://{yourserver.com}/finishActivation
v1

This request is sent by Onlinesim server to close current operation with a certain status (which depends on the result of operation).

By default, this request is sent when the operation time expires (15 minutes for the “Receive SMS” service). The request may also be sent earlier in one of the following two cases: 1) if an SMS from the requested service was successfully received and the client closes the operation manually; 2) if an SMS from the requested service was not received and the client cancels the operation.

IMPORTANT NOTE! Your server must sent successful operation closing response within 10 seconds of the request. Otherwise current request will be cancelled and a new request will be sent.

IMPORTANT NOTE! Please do not close operations on your side until you receive our FINISH_ACTIVATION request. Closing operations manually may lead to status desynchronization and incorrect processing of subsequent requests. Operation closing

Parameters

Authorization
Required

see more here

In: header
Schema:
  • string
    Example: "Bearer apikey"

Request Body

Request payload from Onlinesim server
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"action":"FINISH_ACTIVATION","activationId":355,"sum":4.5,"status":3,"key":"string"}
    Properties:
    • action
      string
      Required
      Method name, in this case `FINISH_ACTIVATION`
      Example: "FINISH_ACTIVATION"
      Enum: FINISH_ACTIVATION
    • activationId
      integer
      Required
      Operation ID (assigned by your server)
      Example: 355
      >= 1
    • sum
      number
      Sum credited to the partner’s balance for the provided service (in RUB)
      Example: 4.5
    • status
      integer
      Required

      Status code of the operation, enum: 1 - This number was not ordered for the current service (i.e., when you try to push SMS for "single-service activation" service, while number has active "rent" operation) 3 - Successfully sold 4 - Cancelled, message was not delivered 5 - Refunded, in case of errors and message problems

      Example: 3
      Enum: 1 3 4 5
    • key
      string
      Required
      API key of your Onlinesim partner's profile
      Example: "string"

Responses

200

The response of your server for `FINISH_ACTIVATION` request must be in following format:
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"status":"SUCCESS"}
    Properties:
    • status
      string
      Request status (`SUCCESS` or `ERROR`)
      Example: "SUCCESS"
      Enum: SUCCESS ERROR