v1

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

POST{yourserver}/finishActivation

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

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

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

Тело запроса

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

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

Примеры

sold

Закрытие проданной операции

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75489,
  "status": 3,
  "key": "apikey"
}
cancelled

Закрытие операции без SMS

{
  "action": "FINISH_ACTIVATION",
  "activationId": 75490,
  "status": 4,
  "key": "apikey"
}

Ответы

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"
}
recordNotFound

Неизвестная операция (для статусов 3 и 4 считается закрытой)

{
  "status": "ERROR",
  "error": "record not found"
}

Примеры кода

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