Правила доступа к абонентским функциям (featurerules)

Содержание

Запросы

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`POST`	`/rest/v1/uc/featurerules`	Создание нового правила
`GET`	`/rest/v1/uc/featurerules`	Получение списка правил
`GET`	`/rest/v1/uc/featurerules/<id>`	Получение данных правила
`PATCH`	`/rest/v1/uc/featurerules/<id>`	Изменение данных правила
`DELETE`	`/rest/v1/uc/featurerules/<id>`	Удаление правила

POST

/rest/v1/uc/featurerules

Создание нового правила

GET

/rest/v1/uc/featurerules

Получение списка правил

GET

/rest/v1/uc/featurerules/<id>

Получение данных правила

PATCH

/rest/v1/uc/featurerules/<id>

Изменение данных правила

DELETE

/rest/v1/uc/featurerules/<id>

Удаление правила

Создание нового правила

Запрос

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

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

POST /rest/v1/uc/featurerules HTTP/1.1
Content-Type: application/json; charset=utf-8

featurerule entity

Ответ

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

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

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "be95db11-0186-7a1b-9d21-7cd30a921f58",
  "name": "num 14",
  "enabled": true,
  "filter_from": "14",
  "filter_to": "*",
  "priority": "115",
  "types": [
    "intercom",
    "pickup",
    "blf",
    "blf_details"
  ],
  "opts": {
    "comment": "",
    "tab": [],
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T17:11:15.487Z",
    "lwt": "2023-02-22T17:11:28.983Z"
  }
}

Получение списка правил

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	Фильтр по значениям полей.
`mask`	`str`	Список полей для вывода. Доступные поля для выдачи: id, prefix, type, extension, priority, opts.title, ext.lwt, ext.ct.
`offset`	`int`	Смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	Максимальное количество ресурсов в списке.
`order`	`array<object\|str>`	Порядок сортировки ресурсов в списке.
`flat`	`bool`	Преобразование в плоский вид составных полей.

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

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

GET /rest/v1/uc/featurerules?filter={"type":"ivr"}&offset=0&limit=2 HTTP/1.1

Ответ

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

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

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "be95db11-0186-7a1b-9d21-7cd30a921f58",
    "name": "num 14",
    "enabled": true,
    "filter_from": "14",
    "filter_to": "*",
    "priority": "115",
    "types": [
      "intercom",
      "pickup",
      "blf",
      "blf_details"
    ],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2023-02-22T17:11:15.487Z",
      "lwt": "2023-02-22T17:11:28.983Z"
    }
  }
]

Получение данных правила

Запрос

Table 2. Параметры запроса
Имя	Тип	Описание
`mask`	`str`	Список полей для вывода.
`flat`	`bool`	Преобразование в плоский вид составных полей.

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

GET /rest/v1/uc/featurerules/dccd337a-016c-d1cf-7393-50e54938780c HTTP/1.1

Ответ

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

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

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "be95db11-0186-7a1b-9d21-7cd30a921f58",
  "name": "num 14",
  "enabled": true,
  "filter_from": "14",
  "filter_to": "*",
  "priority": "115",
  "types": [
    "intercom",
    "pickup",
    "blf",
    "blf_details"
  ],
  "opts": {
    "comment": "",
    "tab": [],
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T17:11:15.487Z",
    "lwt": "2023-02-22T17:11:28.983Z"
  }
}

Изменение данных правила

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

Запрос

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

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

PATCH /rest/v1/uc/featurerules/c0d66244-016c-b869-ead9-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

featurerule entity

Ответ

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

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

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "be95db11-0186-7a1b-9d21-7cd30a921f58",
  "name": "num 14",
  "enabled": true,
  "filter_from": "14",
  "filter_to": "*",
  "priority": "115",
  "types": [
    "intercom",
    "pickup",
    "blf",
    "blf_details"
  ],
  "opts": {
    "comment": "",
    "tab": [],
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T17:11:15.487Z",
    "lwt": "2023-02-22T17:11:28.983Z"
  }
}

Удаление правила

Запрос

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

DELETE /rest/v1/uc/featurerules/c0d66244-016c-b869-ead9-50e54938780c HTTP/1.1

Ответ

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

HTTP/1.1 204 No Content