Webhook get-v2-profile-api

Получить SMS через webhook

Мы добавили возможность пересылки SMS на Ваш сервер! Вы можете установить URL для отправки в настройках Вашего профиля и как только SMS поступит на любой из заказанных Вами номеров, мы отправим его Вам.

Это работает как для приема, так и для долгосрочной аренды!

Вебхук

Схема тела входящего запроса с сообщением описана ниже, в разделе «Входящий payload».

Безопасность

OAuth2Области: sms-scope, rent-scope

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim
rent-scope: grants access to renting phone numbers from Onlinesim

apikey

BearerAuth

Входящий payload

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

Тело запроса с SMS, которое Onlinesim отправляет на ваш webhook URL

Content-Typeapplication/json

Схема

Bodyobject

user_idstring

ID Вашего профиля

country_codestring

Международный телефонный код страны, которой принадлежит номер, получивший SMS

numberstring

Номер телефона в международном формате

senderstring

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

messagestring

Текст SMS

time_startstring

Дата и время начала операции

time_leftstring

Оставшееся время для операции

operation_idstring

ID операции

webhook_typeobject

Тип услуги (прием или аренда)

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

codestring

SMS ID

Примеры

Example 1

Incoming SMS webhook payload

{
  "user_id": "204355",
  "country_code": "7",
  "number": "+79918397701",
  "sender": "OKru",
  "message": "текст смс",
  "time_start": "2023-04-26 12:37:55",
  "time_left": "880",
  "operation_id": "91763432",
  "webhook_type": "receiving_sms",
  "code": "612045"
}

Webhook get-v2-profile-api

Безопасность

Входящий payload

Примеры

Ответ вашего сервера