post{yourserver}/finishActivationRent

POST /finishActivationRent

Завершить операцию аренды виртуального номера

Данный запрос отправляется сервером Onlinesim для закрытия текущей операции аренды с определенным статусом (который зависит от результатов операции).

По умолчанию данный запрос отправляется по истечению времени операции. Запрос также может быть отправлен досрочно в одном из двух случаев:

  1. если SMS от заказанного сервиса было успешно получено и клиент досрочно закрывает операцию аренды;
  2. если SMS от заказанного сервиса не было получено и операция закрывается по истечению защитного интервала (20 минут с момента создания)

Получение запроса со статусом 1 является сигналом о том, что номер по какой-то причине не смог получить SMS от заказанного сервиса в течение трех (или более) операций. Вы можете использовать этот статус как индикатор для необходимости проверки номера и исключить его из выдачи в дальнейшем, либо игнорировать его.

Параметры

header1
НазваниеТипОписание
Authorization*string

Смотрите подробнее тут

Тело запроса

Тело запроса от сервера Onlinesim

Content-Typeapplication/json
Схема
Bodyobject
actionstringОбязательный

Имя метода, в данном случае FINISH_ACTIVATION

Перечисление:FINISH_ACTIVATIONПо умолчанию:FINISH_ACTIVATION
activationIdintegerОбязательный

ID операции (присваивается Вашим сервером)

≥ 1
statusintegerОбязательный

Код статуса операции, enum:

1 - Номер не смог принять SMS в течение трех (или более) операций аренды. Проверьте, есть ли проблемы с этим номером, возможно стоит исключить его из выдачи в дальнейшем

3 - Операция завершена успешно

4 - Операция была отменена, сообщение не было получено

5 - По операции был совершен возврат, в случае ошибок и проблем с сообщением.

Перечисление:134
keystringОбязательный

API ключ Вашего профиля партнера Onlinesim

servicestringОбязательный

Название сервиса. Для аренды всегда rent

Перечисление:rent
sumnumber

Общая стоимость аренды, включая все периоды продления, в рублях (эта сумма будет начислена на Ваш аккаунт партнера Onlinesim при успешном завершении операции аренды)

Примеры

Example payload of Onlinesim server FINISH_ACTIVATION request (for closing rent operation)
{
  "action": "FINISH_ACTIVATION",
  "activationId": 75491,
  "status": 3,
  "key": "apikey",
  "service": "rent",
  "sum": 2408
}

Ответы

200

Ответ Вашего сервера на запрос FINISH_ACTIVATION должен быть в следующем формате:

Content-Typeapplication/json
Схема
Responseobject
statusstring

Статус выполнения запроса (SUCCESS или ERROR)

Перечисление:SUCCESSERROR

Примеры

Response example from your server (when the rental operation was successfuly closed on your server)
{
  "status": "SUCCESS"
}

Примеры кода

Генерация примеров...