v1 rent

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

POST{yourserver}/finishActivationRent

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

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

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

Тело запроса

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

Content-Typeapplication/json
Схема
schemaobject
actionstringОбязательный
Имя метода, в данном случае FINISH_ACTIVATIONПеречисление:FINISH_ACTIVATIONПример:FINISH_ACTIVATION
activationIdintegerОбязательный
ID операции (присваивается Вашим сервером в GET_NUMBER)≥ 1Пример:355
statusintegerОбязательный
Код статуса операции: 3 - аренда использована (SMS получено) 4 - отменено, SMS не было получено 1 - отправляется некоторыми интеграциями вместо 4, когда номер несколько раз не смог принять SMSПеречисление:134Пример:3
keystringОбязательный
API ключ Вашего профиля партнера OnlineSIMПример:apikey
sumnumber
Ваш доход за всю аренду (начальный период плюс все продления), в рублях; зачисляется на Ваш аккаунт OnlineSIM при закрытии арендыПример:870

Примеры

used

Закрытие использованной операции аренды

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75491,
  "status": 3,
  "key": "apikey",
  "sum": 2408
}

Ответы

200Ответ Вашего сервера на FINISH_ACTIVATION (для аренды). Операцию закрывает только status: SUCCESS; для статусов 3 и 4 ответ {"status": "ERROR", "error": "record not found"} также считается закрытием.
Content-Typeapplication/json
Схема
schemaobject
statusstringОбязательный
SUCCESS - аренда закрыта на Вашей стороне; любое другое значение - запрос будет повторенПеречисление:SUCCESSERRORПример:SUCCESS
errorstring
Текст ошибки. record not found (неизвестный activationId) для статусов 3 и 4 считается закрытиемПример:record not found

Примеры

success

Операция аренды закрыта на Вашем сервере

{
  "status": "SUCCESS"
}

Примеры кода

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