post FINISH_ACTIVATION (RENT)

https://{yourserver.com}/finishActivationRent

v1 rent

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

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

ВАЖНО! Вы можете использовать тот же endpoint, что и для закрытия операций по приему SMS (FINISH_ACTIVATION, v1), либо использовать отдельный endpoint исключительно для операций аренды. Однако при первом варианте Вам необходимо модифицировать его, чтобы Ваш сервер корректно обрабатывал запрос для закрытия операции аренды.

ВАЖНО! Ваш сервер должен прислать ответ об успешном закрытии операции аренды в течение 10 секунд после получения запроса. Если по истечению этого времени ответа не последует, текущий запрос автоматически отменяется (направляется новый запрос на закрытие).

ВАЖНО! Пожалуйста, не закрывайте операции на своей стороне до получения от нас запроса FINISH_ACTIVATION. Самостоятельное закрытие операций может привести к рассинхронизации статусов и некорректной обработке последующих запросов.

Parameters

Authorization

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

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

В: header

Схема:

string
Пример: "Bearer apikey"

Global params

Тело запроса

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

Тип содержимого:

application/json

Schema
Examples

object
Пример: {"action":"FINISH_ACTIVATION","activationId":355,"status":3,"key":"string","service":"rent","sum":870}
Свойства:
- action
  string
  Обязательный
  Имя метода, в данном случае `FINISH_ACTIVATION`
  Пример: "FINISH_ACTIVATION"
  Перечисление: FINISH_ACTIVATION
- activationId
  integer
  Обязательный
  ID операции (присваивается Вашим сервером)
  Пример: 355
  >= 1
- status
  integer
  Обязательный
  Код статуса операции, enum: 1 - Номер не был заказан под указанный тип услуги (например, Вы пытатесь отправить сообщение для услуги "Прием", когда номер заказан для "Аренда") 3 - Операция завершена успешно 4 - Операция была отменена, сообщение не было получено 5 - По операции был совершен возврат, в случае ошибок и проблем с сообщением.
  
  Пример: 3
  Перечисление: 1 3 4
- key
  string
  Обязательный
  API ключ Вашего профиля партнера Onlinesim
  Пример: "string"
- service
  string
  Обязательный
  Название сервиса. Для аренды всегда `rent`
  Пример: "rent"
  Перечисление: rent
- sum
  number
  Общая стоимость аренды, включая все периоды продления, в рублях (эта сумма будет начислена на Ваш аккаунт партнера Onlinesim при успешном завершении операции аренды)
  Пример: 870

Ответы

200

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

Тип содержимого:

application/json

Schema
Examples

object
Пример: {"status":"SUCCESS"}
Свойства:
- status
  string
  Статус выполнения запроса (`SUCCESS` или `ERROR`)
  Пример: "SUCCESS"
  Перечисление: SUCCESS ERROR