Функциональные группы вызова (sipkits)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/sipkits

Создание новой группы

GET

/rest/v1/uc/sipkits

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

GET

/rest/v1/uc/sipkits/<id>

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

PATCH

/rest/v1/uc/sipkits/<id>

Изменение данных группы

DELETE

/rest/v1/uc/sipkits/<id>

Удаление группы


Создание новой группы

Запрос

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

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

sipkit entity

Ответ

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

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

{
  "id": "182dc715-0186-7858-a770-7cd30a921f58",
  "name": "chief 101",
  "enabled": true,
  "cascade": false,
  "priority": "115",
  "type": "chief",
  "details": {
    "chief_number": "101",
    "assistant1_number": "102",
    "assistant2_number": "103",
    "mode": "direct",
    "direct_numbers": [
      "115", "123"
    ]
  },
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T08:58:41.391Z",
    "lwt": "2023-03-01T07:13:17.076Z"
  }
}

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

Запрос

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

filter

object

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

mask

str

Список полей для вывода. Доступные поля для выдачи: id, name, type, details, enabled, cascade, priority, opts.title, ext.lwt, ext.ct.

offset

int

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

limit

int

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

order

array<object|str>

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

flat

bool

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

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

Ответ

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

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

[
  {
    "id": "182dc715-0186-7858-a770-7cd30a921f58",
    "name": "chief 101",
    "enabled": true,
    "cascade": false,
    "priority": "115",
    "type": "chief",
    "details": {
      "chief_number": "101",
      "assistant1_number": "102",
      "assistant2_number": "103",
      "mode": "direct",
      "direct_numbers": [
        "115", "123"
      ]
    },
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2023-02-22T08:58:41.391Z",
      "lwt": "2023-03-01T07:13:17.076Z"
    }
  },
  {
    "id": "15151515-1515-1515-1515-7cd30a921f58",
    "name": "parallel 11,12",
    "enabled": true,
    "cascade": false,
    "priority": "120",
    "type": "parallel",
    "details": {
      "filter_by": "*",
      "filter_from": "14",
      "numbers_to": [
        "11",
        "12"
      ],
      "numbers_parallel": [
        "12",
        "11"
      ]
    },
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2023-02-22T08:58:41.391Z",
      "lwt": "2023-03-01T07:13:17.076Z"
    }
  }
]

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

Запрос

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

mask

str

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

flat

bool

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

Пример запроса
GET /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1

Ответ

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

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

{
  "id": "182dc715-0186-7858-a770-7cd30a921f58",
  "name": "chief 101",
  "enabled": true,
  "cascade": false,
  "priority": "115",
  "type": "chief",
  "details": {
    "chief_number": "101",
    "assistant1_number": "102",
    "assistant2_number": "103",
    "mode": "direct",
    "direct_numbers": [
      "115", "123"
    ]
  },
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T08:58:41.391Z",
    "lwt": "2023-03-01T07:13:17.076Z"
  }
}

Изменение данных группы

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

Запрос

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

Пример запроса
PATCH /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1
Content-Type: application/json; charset=utf-8

sipkit entity

Ответ

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

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

{
  "id": "182dc715-0186-7858-a770-7cd30a921f58",
  "name": "chief 101",
  "enabled": true,
  "cascade": false,
  "priority": "115",
  "type": "chief",
  "details": {
    "chief_number": "101",
    "assistant1_number": "102",
    "assistant2_number": "103",
    "mode": "direct",
    "direct_numbers": [
      "115", "123"
    ]
  },
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2023-02-22T08:58:41.391Z",
    "lwt": "2023-03-01T07:13:17.076Z"
  }
}

Удаление группы

Запрос

Пример запроса
DELETE /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1

Ответ

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