Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET https://api.smartsender.eu/v1/channels

 

Основные параметры:

 

Название

Описание

Валидация

page

Запрашиваемая страница

Минимальное значение 1

limitation

Количество данных для вывода на странице

Минимальное значение 1, максимальное 20

...

В случае успешного ответа получите следующее:

 

Code Block
{
    "cursor": {
        "page": 1,
   Cursor,
    "pages": 3
    },
    "collection": [
        {
            "id": 16,
            "active": true,
            "occupied": true,
            "type": "skype",
            "name": "SmartSender",
            "referrer": 4,
            "link": "http:\/\/join.skype.com\/bot\/7b71302e-42da-4bbd-90a9-44526835aa13",
            "app": "skype:\/\/28:7b71302e-42da-4bbd-90a9-44526835aa13?chat",
            "createdAt": "2019-08-09 17:23:30",
            "updatedAt": "2019-08-09 17:23:30"
        },
        {
            "id": 34,
            "active": true,
            "occupied": true,
            "type": "facebook",
            "name": "Smart Sender",
            "referrer": 12,
            "link": "https:\/\/m.me\/1139181152871740",
            "app": "fb-messenger:\/\/1139181152871740",
            "createdAt": "2019-11-13 11:08:15",
            "updatedAt": "2019-11-13 11:08:15"
        }
    Channel[]
}

 

Описание ответа: 

Название

Описание

cursor.page

Запрашиваемая страница

cursor.pages

Количество страниц с указанным лимитом вывода

collection.*.id

ID канала

collection.*.active

Активность канал

collection.*.occupied

Статус подключения канала

collection.*.type

Тип канала

collection.*.name

Название канала

collection.*.referrer

Внутренний идентификатор трекера

collection.*.link

Ссылка на канал

collection.*.app

Ссылка приложения на канал

collection.*.createdAt

Дата создания канала

collection.*.updatedAt

Дата обновления канала

Объект типа Cursor

collection

Массив объектов типа Channel

 

Получение по ID.

Позволяет просмотреть подключенный канал в проекте по идентификатору.

...

В случае успешного ответа получите следующее:

 

Code Block
{
    "id": 16,
    "active": true,
    "occupied": true,
    "type": "skype",
    "name": "SmartSender",
    "referrer": 4,
    "link": "http:\/\/join.skype.com\/bot\/7b71302e-42da-4bbd-90a9-44526835aa13",
    "app": "skype:\/\/28:7b71302e-42da-4bbd-90a9-44526835aa13?chat",
    "createdAt": "2019-08-09 17:23:30",
    "updatedAt": "2019-08-09 17:23:30"
}

 

Описание ответа:

 

Название

Описание

id

ID канала

active

Активность канал

occupied

Статус подключения канала

type

Тип канала

name

Название канала

referrer

Внутренний идентификатор трекера

link

Ссылка на канал

app

Ссылка приложения на канал

createdAt

Дата создания канала

updatedAt

Дата обновления канала

 объект типа Channel.

Обновление.

Позволяет изменить активность выбранного канала.

...