posthttps://{ourserver.com}/v1/PUSH_SMS

Webhook POST /v1/PUSH_SMS

Отправить SMS в Onlinesim

Это webhook для отправки сообщения на сервер Onlinesim. Этот запрос должен выполняться лишь тогда, когда Ваш номер получил сообщение на заказанный номер для его (сообщения) последующей передачи на сервер Onlinesim.

Если Вы получили ответ со статусом 200(OK), в Вашей базе данных SMS может быть помечено как успешно доставленное (повторно отправлять запрос не нужно).

Если код статуса отличен от 200(OK), то необходимо повторно отправить запрос с тем же контентом через 10 секунд (за исключением получения ошибок NO_OPERATION или BAD_SERVICE).

Ниже описаны ответы с возможными ошибками:

  • NO_OPERATION / NO_OP - эта ошибка возникает, когда Вы пытаетесь отправить SMS на номер, у которого нет активной операции;
  • BAD_SERVICE - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который заблокирован нашим сервером (банка, платежной системы, МФО и т.д.);
  • IGNORED - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, отличающегося от того, что заказал клиент (появляется только в том случае, если фильтрация сообщений производится на нашей стороне);
  • SERVICE_BAN - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который Вы внесли в черный список (Вы можете добавлять сервисы в черный список, что не позволит клиентам заказывать Ваши номера для приема сообщений от этих сервисов)

Параметры

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

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

Content-Type*string

Заголовок Content type и кодировка

Перечисление:application/json; charset=utf-8

Тело запроса

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

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

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

≥ 1
phoneFromstringОбязательный

Имя или номер отправителя

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

'Номер телефона с активной операцией, принявший SMS'

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

Текст сообщения

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

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

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

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

Примеры

Example payload of your server PUSH_SMS request
{
  "smsId": 124971,
  "phoneFrom": "vk",
  "phone": "79104041216",
  "text": "Your OTP 46875",
  "action": "PUSH_SMS",
  "key": "apikey"
}

Ответы

200

Ответ сервера Onlinesim

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

Статус ответа сервера Onlinesim

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

Примеры

Onlinesim server response example for successfuly received SMS
{
  "status": "SUCCESS"
}
When pushing SMS to a number that has no active operation
NO_OP
When pushing SMS from a service that is banned by our server (banks, payment systems, etc.)
BAD_SERVICE
When pushing SMS from a service that is differs from the one the client has ordered (only appears when filtration is done on our side)
IGNORED
When pushing SMS from a service you've added to the blacklist
SERVICE_BAN
When rate limit for PUSH_SMS_RENT requests is exceeded
TOO_MANY_ATTEMPTS
404

NO_OPERATION / NO_OP

Эта ошибка появляется, когда Вы пытаетесь отправить SMS на номер, у которого нет активной операции

Примеры кода

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