post PUSH_SMS (RENT)

https://{ourserver.com}/pushSmsRent
v1 rent

ВАЖНО!
URL сервера Onlinesim предоставляется сотрудниками партнерской поддержки. Обратите внимание, что URL сервера 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

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

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

В: header
Схема:
  • string
    Пример: Bearer apiKey
Content-Type
Обязательный
Заголовок `Content type` и кодировка
В: header
Схема:
  • string
    Пример: application/json; charset=utf-8
    Перечисление: application/json; charset=utf-8

Global params

Тело запроса

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

Тип содержимого:
application/json
  • 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
    • service
      string
      Обязательный
      Название сервиса. Для аренды всегда `rent`
      Пример: rent
      Перечисление: rent

Ответы

200

Ответ сервера Onlinesim
Заголовки
Содержание
Тип содержимого:
application/json
  • Schema
  • Examples
  • object
    Свойства:
    • status
      string
      Статус ответа сервера Onlinesim
      Пример: SUCCESS
      Перечисление: SUCCESS ERROR