post PUSH_SMS
https://{ourserver.com}/pushSms
ВАЖНО!
URL сервера Onlinesim предоставляется сотрудниками партнерской поддержки. Обратите внимание, что URL сервера Onlinesim в примере заменен на заглушку.
Это webhook для отправки сообщения на сервер Onlinesim. Этот запрос должен выполняться лишь тогда, когда Ваш номер получил сообщение на заказанный номер для его (сообщения) последующей передачи на сервер Onlinesim.
Если Вы получили ответ со статусом 200(OK), в Вашей базе данных SMS может быть помечено как успешно доставленное (повторно отправлять запрос не нужно).
Если код статуса отличен от 200(OK), то необходимо повторно отправить запрос с тем же контентом через 10 секунд (за исключением получения ошибок NO_OPERATION
или BAD_SERVICE
).
ВАЖНО!
Заголовок запроса 'Content-Type' должен содержать utf-8 кодировку в качестве значения
('Content-Type': 'application/json; charset=utf-8').
Ниже описаны ответы с возможными ошибками:
NO_OPERATION
/ NO_OP
- эта ошибка возникает, когда Вы пытаетесь отправить SMS на номер, у которого нет активной операции;
BAD_SERVICE
- эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который заблокирован нашим сервером (банка, платежной системы, МФО и т.д.);
IGNORED
- эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, отличающегося от того, что заказал клиент (появляется только в том случае, если фильтрация сообщений производится на нашей стороне);
SERVICE_BAN
- эта ошибка возникает, когда Вы пытаетесь отправить SMS от сервиса, который Вы внесли в черный список (Вы можете добавлять сервисы в черный список, что не позволит клиентам заказывать Ваши номера для приема сообщений от этих сервисов)
Серверы
https://{ourserver.com}
Parameters
Content-Type
header
- stringПример:
application/json; charset=utf-8
Перечисление:application/json; charset=utf-8
Global params
Тело запроса
PUSH_SMS webhook: Ваш сервер должен отправлять этот запрос при наступлении события (когда заказанный номер получил сообщение).
- Schema
- Examples
- objectСвойства:
smsId
integerОбязательныйID операции (присваивается Вашим сервером)Пример:355
>= 1
phoneFrom
stringОбязательныйИмя или номер отправителяПример:Instagram
phone
stringОбязательныйНомер телефона с активной операцией, принявший SMSПример:79088081050
text
stringОбязательныйТекст сообщенияПример:Your verification code is 800142
action
stringОбязательныйИмя метода, в данном случае `PUSH_SMS`Пример:PUSH_SMS
Перечисление:PUSH_SMS
key
stringОбязательныйAPI ключ Вашего профиля партнера Onlinesim
Ответы
200
- Schema
- Examples
- objectСвойства:
status
stringСтатус ответа сервера OnlinesimПример:SUCCESS
Перечисление:SUCCESS
ERROR