gethttp://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentStatus

GET /stubs/handler_api.php?action=getRentStatus

Получить статус операции аренды

Этот запрос возвращает список SMS, полученных данным арендным виртуальным номером.

Вы можете использовать этот запрос для проверки полученного SMS-сообщения указанным номером для последующей обработки данных в Вашем приложении.

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

api_key
BearerAuth
OAuth2Области: rent-scope
rent-scope
grants access to renting phone numbers from Onlinesim

Параметры

query2
НазваниеТипОписание
action*string

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

Перечисление:getRentStatusПо умолчанию:getRentStatus
id*integer

ID операции (выдается при заказе, смотри getRentList)

Пример:10000

Ответы

200

Успешный ответ от сервера на запрос getRentStatus: либо возвращает список полученных указанным арендным номером SMS-сообщений, либо выбрасывает исключение.

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

Статус выполнения запроса

Пример:success
quantityinteger

Общее количество сообщений, полученных этим номером

valuesobject

Список SMS сообщений

#sms_index#object

ID SMS-сообщения, начиная с 0

phoneFromstring

Арендный номер, который получил сообщение (в международном формате, со знаком "+")

Пример:+79089102030
textstring

Содержание SMS-сообщения

Пример:Your verification code is 070501
servicestring

Имя или номер отправителя SMS-сообщения

Пример:twitter
datestring

Дата и время приема SMS-сообщения

Пример:2021-02-02T14:46:49+03:00

Примеры

List of received messages example response
{
  "status": "success",
  "quantity": 1,
  "values": {
    "#sms_index#": {
      "phoneFrom": "+79089102030",
      "text": "Your verification code is 070501",
      "service": "twitter",
      "date": "2021-02-02T14:46:49+03:00"
    }
  }
}

Примеры кода

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