Отправка SMS в OnlineSIM для операции аренды

POSThttps://{ourserver.com}/v1/PUSH_SMS_RENT

Тот же webhook, что и PUSH_SMS, отправляемый на тот же URL: значение service, начинающееся с rent, направляет SMS в операцию аренды на phone. Поддержка аренды зависит от интеграции.

Первое SMS подтверждает аренду. SMS от заблокированного отправителя (банки, платежные системы и т. д.) показывается клиенту как уведомление вместо текста и не подтверждает аренду.

Если Вы получили {"status": "SUCCESS"}, SMS можно пометить в Вашей базе данных как доставленное (не отправляйте его повторно).

На бизнес-ошибки приходит ответ HTTP 200 и {"status": "ERROR", "error": "<code>"}; они окончательны, не повторяйте такие запросы. Если запрос завершился ошибкой на сетевом уровне или получил ответ HTTP 500 (INTERNAL_ERROR), повторите его после паузы (например, 10 секунд).

Возможные ошибки (набор зависит от интеграции):

  • NO_OP - на номере нет активной операции аренды;
  • SERVICE_BAN / BANNED - отправитель заблокирован (SMS все равно может быть показано клиенту как уведомление);
  • INTERNAL_ERROR (HTTP 500) - запрос не удалось обработать.

Тело запроса

Webhook PUSH_SMS для номера в аренде: Ваш сервер должен отправить этот запрос при наступлении события (когда арендованный номер получил сообщение).

Content-Typeapplication/json
Схема
schemaobject
smsIdinteger
ID операции (activationId, который Вы вернули в GET_NUMBER)≥ 1Пример:355
phoneFromstringОбязательный
Имя или номер телефона отправителя (все после @ отбрасывается)Пример:Instagram
phonestringОбязательный
Арендованный номер телефона, на который пришло SMS, в международном формате с кодом страны, только цифры (как возвращен в GET_NUMBER)Пример:79088081050
textstringОбязательный
Текст сообщенияПример:Your verification code is 800142
actionstring
Имя метода, в данном случае PUSH_SMSПеречисление:PUSH_SMSПример:PUSH_SMS
keystring
API ключ Вашего профиля партнера OnlineSIM. Интеграция определяется по URL webhook'а; проверяется ли ключ, зависит от интеграцииПример:apikey
servicestringОбязательный
Помечает SMS как SMS аренды: любое значение, начинающееся с rent, например rentПример:rent

Примеры

request

Запрос PUSH_SMS от Вашего сервера (для арендованного номера)

{
  "smsId": 124980,
  "phoneFrom": "instagram",
  "phone": "4605028040",
  "text": "784958 is your secret code",
  "action": "PUSH_SMS",
  "key": "apikey",
  "service": "rent"
}

Ответы

200Ответ сервера OnlineSIM: SMS принято или отклонено с кодом ошибки
Content-Typeapplication/json
Схема
schemaobject
statusstringОбязательный
Статус ответаПеречисление:SUCCESSERRORПример:SUCCESS
errorstring
Код ошибки (при status: ERROR)Перечисление:NO_OPSERVICE_BANBANNEDПример:NO_OP

Примеры

success

SMS принято

{
  "status": "SUCCESS"
}
NO_OP

Нет активной операции аренды для этого номера

{
  "status": "ERROR",
  "error": "NO_OP"
}
SERVICE_BAN

Отправитель заблокирован

{
  "status": "ERROR",
  "error": "SERVICE_BAN"
}
500Запрос не удалось обработать: повторите его позже
Content-Typeapplication/json
Схема
schemaobject
statusstring
Перечисление:ERRORПример:ERROR
errorstring
Перечисление:INTERNAL_ERRORПример:INTERNAL_ERROR

Примеры кода

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