POST /finishActivationRent
Завершить операцию аренды виртуального номера
Данный запрос отправляется сервером Onlinesim для закрытия текущей операции аренды с определенным статусом (который зависит от результатов операции).
По умолчанию данный запрос отправляется по истечению времени операции. Запрос также может быть отправлен досрочно в одном из двух случаев:
- если SMS от заказанного сервиса было успешно получено и клиент досрочно закрывает операцию аренды;
- если SMS от заказанного сервиса не было получено и операция закрывается по истечению защитного интервала (20 минут с момента создания)
TIP
Вы можете использовать тот же endpoint, что и для закрытия операций по приему SMS (FINISH_ACTIVATION, v1), либо использовать отдельный endpoint исключительно для операций аренды.
Однако при первом варианте Вам необходимо модифицировать его, чтобы Ваш сервер корректно обрабатывал запрос для закрытия операции аренды.
WARNING
Ваш сервер должен прислать ответ об успешном закрытии операции аренды в течение 10 секунд после получения запроса. Если по истечению этого времени ответа не последует, текущий запрос автоматически отменяется (направляется новый запрос на закрытие).
DANGER
Пожалуйста, не закрывайте операции на своей стороне до получения от нас запроса FINISH_ACTIVATION. Самостоятельное закрытие операций может привести к рассинхронизации статусов и некорректной обработке последующих запросов.
Параметры
| Название | Тип | Описание |
|---|---|---|
Authorization* | string | Смотрите подробнее тут Пример: Bearer apikey |
Тело запроса
Тело запроса от сервера Onlinesim
Content-Type:
application/jsonBodyobject
actionstringОбязательный
Имя метода, в данном случае FINISH_ACTIVATION
Перечисление:
FINISH_ACTIVATIONПо умолчанию:
FINISH_ACTIVATIONПример:
FINISH_ACTIVATIONactivationIdintegerОбязательный
ID операции (присваивается Вашим сервером)
≥ 1
Пример:
355statusintegerОбязательный
Код статуса операции, enum:
1 - Номер не был заказан под указанный тип услуги
(например, Вы пытатесь отправить сообщение для услуги
“Прием”, когда номер заказан для “Аренда”)
3 - Операция завершена успешно
4 - Операция была отменена, сообщение не было получено
5 - По операции был совершен возврат, в случае ошибок и
проблем с сообщением.
Перечисление:
134Пример:
3keystringОбязательный
API ключ Вашего профиля партнера Onlinesim
servicestringОбязательный
Название сервиса. Для аренды всегда rent
Перечисление:
rentПример:
rentsumnumber
Общая стоимость аренды, включая все периоды продления, в
рублях (эта сумма будет начислена на Ваш аккаунт партнера
Onlinesim при успешном завершении операции аренды)
Пример:
870Ответы
200
Ответ Вашего сервера на запрос FINISH_ACTIVATION должен быть в
следующем формате:
Примеры кода
Примеры кода недоступны