post{yourserver}/finishActivation

POST /finishActivation

Завершить текущую операцию приема

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

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

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

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

Параметры

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

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

Тело запроса

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

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

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

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

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

≥ 1
sumnumber

Сумма, зачисленная на баланс партнера, за оказанную услугу (в рублях)

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

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

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

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

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

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

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

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

Примеры

Example payload of Onlinesim server FINISH_ACTIVATION request
{
  "action": "FINISH_ACTIVATION",
  "activationId": 75489,
  "status": 3,
  "key": "apikey"
}

Ответы

200

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

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

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

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

Примеры

Successful response example from your server
{
  "status": "SUCCESS"
}

Примеры кода

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