POST /finishActivationRent
Finish rent operation of a virtual phone number
This request is sent by Onlinesim server to close current rent operation with a specific status (which depends on the result of operation).
By default, this request is sent when the operation time expires. The request may also be sent earlier in one of the following two cases:
- if an SMS from the requested service was successfully received and the client closes the rental operation ahead of time;
- if an SMS from the requested service was not received and the operation is closed after the protective interval expires (20 minutes from the moment the operation was created).
TIP
You can either create a new endpoint for the rent only or use your existing FINISH_ACTIVATION endpoint for single-service activations (v1).
However in the latter case you need to modify it so your server could process the closing of rental operations correctly.
WARNING
Your server must sent successful rent 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.
Parameters
| Name | Type | Description |
|---|---|---|
Authorization* | string | see more here Example: Bearer apikey |
Request Body
Request payload from Onlinesim server
Content-Type:
application/jsonBodyobject
actionstringRequired
Method name, in this case FINISH_ACTIVATION
Enum:
FINISH_ACTIVATIONDefault:
FINISH_ACTIVATIONExample:
FINISH_ACTIVATIONactivationIdintegerRequired
Operation ID (assigned by your server)
≥ 1
Example:
355statusintegerRequired
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:
134Example:
3keystringRequired
API key of your Onlinesim partner’s profile
servicestringRequired
Service name, in this case rent
Enum:
rentExample:
rentsumnumber
Total service price that includes all rental periods, in RUB
(this sum will be credited to your Onlinesim account after
successful rental operation)
Example:
870Responses
200
The response of your server for FINISH_ACTIVATION request must be
in following format:
Code Samples
No code samples available