chatcampaigns (chatcampaigns)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/chatcampaigns

Создание новой чат-кампании

GET

/rest/v1/uc/chatcampaigns

Получение списка чат-кампаний

GET

/rest/v1/uc/chatcampaigns/<id>

Получение данных чат-кампании

PATCH

/rest/v1/uc/chatcampaigns/<id>

Изменение данных чат-кампании

DELETE

/rest/v1/uc/chatcampaigns/<id>

Удаление чат-кампании

LOOKUP

/rest/v1/uc/chatcampaigns

Поиск идентификатора чат-кампании

Создание новой чат-кампании

Запрос

Описание полей: chatcampaign entity

Пример запроса
POST /rest/v1/uc/chatcampaigns HTTP/1.1
Content-Type: application/json; charset=utf-8

chatcampaign entity

Ответ

Описание полей: chatcampaign entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "d85eaf2d-016c-d844-4c09-50e54938780c",
  "code": "a709",
  "name": "Band&09",
  "projectid": "00000000-0000-0000-0000-000000000000",
  "autobot": "autobot",
  "queuebot": "queuebot",
  "dialogbot": "dialogbot",
  "inactivebot": "inactivebot",
  "rotationbot": "rotationbot",
  "finalbot": "finalbot",
  "stopbot": "stopbot",
  "gethistoryscr": "chat_gethistoryscr",
  "searchhistoryscr": "chat_searchhistoryscr",
  "ctxmenuscr": "chat_ctxmenuscr",
  "defaulthuntuser": "",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T12:47:30.31Z",
    "lwt": "2019-08-28T12:47:30.31Z"
  }
}

Получение списка чат-кампаний

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, code, name, projectid, autobot, queuebot, dialogbot, inactivebot, rotationbot, finalbot, stopbot, gethistoryscr, searchhitoryscr, ctxmenuscr, defaulthuntuser, opts.title, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/uc/chatcampaigns?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: chatcampaign entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "30289385-016c-d825-2892-50e54938780c",
    "code": "a707",
    "name": "Band707",
    "projectid": "00000000-0000-0000-0000-000000000000",
    "autobot": "autobot",
    "queuebot": "queuebot",
    "dialogbot": "dialogbot",
    "inactivebot": "inactivebot",
    "rotationbot": "rotationbot",
    "finalbot": "finalbot",
    "stopbot": "stopbot",
    "gethistoryscr": "chat_gethistoryscr",
    "searchhistoryscr": "chat_searchhistoryscr",
    "ctxmenuscr": "chat_ctxmenuscr",
    "defaulthuntuser": "",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T12:13:29.61Z",
      "lwt": "2019-08-28T12:13:29.61Z"
    }
  },
  {
    "id": "d85eaf2d-016c-d844-4c09-50e54938780c",
    "code": "a709",
    "name": "Band&09",
    "projectid": "00000000-0000-0000-0000-000000000000",
    "autobot": "autobot",
    "queuebot": "queuebot",
    "dialogbot": "dialogbot",
    "inactivebot": "inactivebot",
    "rotationbot": "rotationbot",
    "finalbot": "finalbot",
    "stopbot": "stopbot",
    "gethistoryscr": "chat_gethistoryscr",
    "searchhistoryscr": "chat_searchhistoryscr",
    "ctxmenuscr": "chat_ctxmenuscr",
    "defaulthuntuser": "",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T12:47:30.31Z",
      "lwt": "2019-08-28T12:47:30.31Z"
    }
  }
]

Получение данных чат-кампании

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/uc/chatcampaigns/d85eaf2d-016c-d844-4c09-50e54938780c HTTP/1.1

Ответ

Описание полей: chatcampaign entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "d85eaf2d-016c-d844-4c09-50e54938780c",
  "code": "a709",
  "name": "Band&09",
  "projectid": "00000000-0000-0000-0000-000000000000",
  "autobot": "autobot",
  "queuebot": "queuebot",
  "dialogbot": "dialogbot",
  "inactivebot": "inactivebot",
  "rotationbot": "rotationbot",
  "finalbot": "finalbot",
  "stopbot": "stopbot",
  "gethistoryscr": "chat_gethistoryscr",
  "searchhistoryscr": "chat_searchhistoryscr",
  "ctxmenuscr": "chat_ctxmenuscr",
  "defaulthuntuser": "",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T12:47:30.31Z",
    "lwt": "2019-08-28T12:47:30.31Z"
  }
}

Изменение данных чат-кампании

Поля запрещенные для изменения: id

Запрос

Описание полей: chatcampaign entity

Пример запроса
PATCH /rest/v1/uc/chatcampaigns/d85eaf2d-016c-d844-4c09-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

chatcampaign entity

Ответ

Описание полей: chatcampaign entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "d85eaf2d-016c-d844-4c09-50e54938780c",
  "code": "a709",
  "name": "Band&09",
  "projectid": "00000000-0000-0000-0000-000000000000",
  "autobot": "autobot",
  "queuebot": "queuebot",
  "dialogbot": "dialogbot",
  "inactivebot": "inactivebot",
  "rotationbot": "rotationbot",
  "finalbot": "finalbot",
  "stopbot": "stopbot",
  "gethistoryscr": "chat_gethistoryscr",
  "searchhistoryscr": "chat_searchhistoryscr",
  "ctxmenuscr": "chat_ctxmenuscr",
  "defaulthuntuser": "",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T12:47:30.31Z",
    "lwt": "2019-08-28T17:30:22.54Z"
  }
}

Удаление чат-кампании

Запрос

Пример запроса
DELETE /rest/v1/uc/chatcampaigns/d85eaf2d-016c-d844-4c09-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора чат-кампании

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id, code

Запрос

Пример запроса
LOOKUP /rest/v1/uc/chatcampaigns HTTP/1.1
Content-Type: application/json; charset=utf-8

"a709"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "d85eaf2d-016c-d844-4c09-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт