Loyalty

  1. Домой
  2. Документация
  3. Loyalty
  4. SMS сервис
  5. Описание API

Описание API

/sms/list

Метод предназначен, для получения информации о всех SMS, попавших в сервис.

Запрос

URL: https://<адрес сервиса SMS>/sms/list
Метод: GET

Заголовки

Authorization: Bearer <token>
Content-Type: application/json

Пример запроса

https://<адрес сервиса SMS>/sms/list?offset=0&limit=10&phone=79874540777

Описание параметров

ПараметрТипОписание
offsetnumberКакое количество объектов в списке необходимо пропустить
Default = 0
limitnumberКоличество объектов на одной странице
Default = 10
phonestring Номер телефона
По нему отображаются SMS, при не заполнении данного поля, покажутся SMS по всем номерам

Ответ

Пример ответа

{
    "id": "c20a3799-63c8-4d49-a457-73d27f512677",
    "date": "2019-06-07T00:34:47.738344",
    "senderName": "Samarasoft",
    "text": "Скажите продавцу код 6537! Покупка в магазине 00:34 07.06.2019",
    "phone": "79874540777",
    "result": {
        "success": true
    }
}

Описание параметров

Параметр
Тип Описание
id
guid Id SMS
client object Данные клиента
date Date
Дата получение сигнала об отправки SMS в сервис
senderName string Имя отправителя
text string Текст SMS
phone string Телефон
result object Результат отправки SMS
success bool Успешна ли отправка
errorFromResponse string Ошибка от провайдера SMS
errorFromException string Ошибка из Exception

Материал был полезен? Да 3 Нет