Skip to content

POST /v1/PUSH_SMS_RENT

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

WARNING

URL сервера Onlinesim предоставляется сотрудниками партнерской поддержки. Обратите внимание, что URL сервера Onlinesim в примере заменен на заглушку.

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

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

WARNING

Заголовок запроса 'Content-Type' должен содержать utf-8 кодировку в качестве значения

('Content-Type': 'application/json; charset=utf-8').

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

  • NO_OPERATION / NO_OP - эта ошибка возникает, когда Вы пытаетесь отправить SMS на номер, у которого нет активной операции;

  • BAD_SERVICE - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который заблокирован нашим сервером (банка, платежной системы, МФО и т.д.);

  • IGNORED - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, отличающегося от того, что заказал клиент (появляется только в том случае, если фильтрация сообщений производится на нашей стороне);

  • SERVICE_BAN - эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который Вы внесли в черный список (Вы можете добавлять сервисы в черный список, что не позволит клиентам заказывать Ваши номера для приема сообщений от этих сервисов)

Параметры

Нет параметров

Тело запроса

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

Content-Type:application/json
Bodyobject
smsIdintegerОбязательный

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

≥ 1
Пример:355
phoneFromstringОбязательный

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

Пример:Instagram
phonestringОбязательный

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

Пример:79088081050
textstringОбязательный

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

Пример:Your verification code is 800142
actionstringОбязательный

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

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

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

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

Название сервиса. Для аренды всегда rent

Перечисление:rent
Пример:rent

Ответы

200

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

Примеры кода