Skip to content

POST /finishActivation

Finish current operation

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.

WARNING

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.

DANGER

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

NameTypeDescription
Authorization*string

see more here

Example:Bearer apikey

Request Body

Request payload from Onlinesim server

Content-Type:application/json
Bodyobject
actionstringRequired

Method name, in this case FINISH_ACTIVATION

Enum:FINISH_ACTIVATION
Default:FINISH_ACTIVATION
Example:FINISH_ACTIVATION
activationIdintegerRequired

Operation ID (assigned by your server)

≥ 1
Example:355
sumnumber

Sum credited to the partner’s balance for the provided
service (in RUB)

Example:4.5
statusintegerRequired

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

Enum:1345
Example:3
keystringRequired

API key of your Onlinesim partner’s profile

Responses

200

The response of your server for FINISH_ACTIVATION request must be
in following format:

Code Samples