Завершить операцию аренды виртуального номера
POST{yourserver}/finishActivationRent
Данный запрос отправляется сервером OnlineSIM для закрытия текущей операции аренды со статусом, который зависит от ее результата.
По умолчанию данный запрос отправляется по истечении срока аренды. Он также может быть отправлен досрочно:
- когда клиент досрочно завершает аренду;
- когда в течение периода ожидания после создания операции не было получено ни одного SMS (по умолчанию 20 минут, зависит от интеграции) - со статусом
4.
Тело запроса
Тело запроса от сервера OnlineSIM
Content-Type
application/jsonСхема
schemaobject
actionstringОбязательный
Имя метода, в данном случае FINISH_ACTIVATIONПеречисление:FINISH_ACTIVATIONПример:FINISH_ACTIVATIONactivationIdintegerОбязательный
ID операции (присваивается Вашим сервером в GET_NUMBER)≥ 1Пример:355statusintegerОбязательный
Код статуса операции:
3 - аренда использована (SMS получено)
4 - отменено, SMS не было получено
1 - отправляется некоторыми интеграциями вместо 4, когда номер несколько раз не смог принять SMSПеречисление:134Пример:3keystringОбязательный
API ключ Вашего профиля партнера OnlineSIMПример:apikeysumnumber
Ваш доход за всю аренду (начальный период плюс все продления), в рублях; зачисляется на Ваш аккаунт 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-Type
application/jsonСхема
schemaobject
statusstringОбязательный
SUCCESS - аренда закрыта на Вашей стороне; любое другое значение - запрос будет повторенПеречисление:SUCCESSERRORПример:SUCCESSerrorstring
Текст ошибки. record not found (неизвестный activationId) для статусов 3 и 4 считается закрытиемПример:record not foundПримеры
success
Операция аренды закрыта на Вашем сервере
{
"status": "SUCCESS"
}Примеры кода
Генерация примеров...