Групповые номера (sipgroups)

Содержание

Запросы

Запросы

HTTP verb Endpoint Описание

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

POST

/rest/v1/uc/sipgroups

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

GET

/rest/v1/uc/sipgroups

Получение списка групповых номеров

GET

/rest/v1/uc/sipgroups/<id>

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

PATCH

/rest/v1/uc/sipgroups/<id>

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

DELETE

/rest/v1/uc/sipgroups/<id>

Удаление группового номера

LOOKUP

/rest/v1/uc/sipgroups

Поиск идентификатора группового номера

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

Запрос

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

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

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

group entity

Ответ

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

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

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

{
  "id": "ba18a3e4-016c-d758-54da-50e54938780c",
  "phonenumber": "500",
  "type": "cascade",
  "dialplan": [
    {
      "dial": ["511"],
      "timeout": 10000
    },
    {
      "dial": ["512", "513"]
    }
  ],
  "pickup": 1,
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T08:29:46.74Z",
    "lwt": "2019-08-28T08:29:46.74Z"
  }
}

Получение списка групповых номеров

Запрос

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

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

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

GET /rest/v1/uc/sipgroups?offset=0&limit=2 HTTP/1.1

Ответ

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

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

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

[
  {
    "id": "495079be-016c-d757-e913-50e54938780c",
    "phonenumber": "200",
    "type": "random",
    "dialplan": [
      {"dial": ["211", "212"]}
    ],
    "pickup": 0,
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T08:29:18.48Z",
      "lwt": "2019-08-28T08:29:18.48Z"
    }
  },
  {
    "id": "ba18a3e4-016c-d758-54da-50e54938780c",
    "phonenumber": "500",
    "type": "random",
    "dialplan": [
      {"dial": ["511"]},
      {"dial": ["511", "512"]}
    ],
    "pickup": 1,
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T08:29:46.74Z",
      "lwt": "2019-09-08T12:13:55.01Z"
    }
  }
]

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

Запрос

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

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

GET /rest/v1/uc/sipgroups/ba18a3e4-016c-d758-54da-50e54938780c HTTP/1.1

Ответ

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

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

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

{
  "id": "ba18a3e4-016c-d758-54da-50e54938780c",
  "phonenumber": "500",
  "type": "cascade",
  "dialplan": [
    {
      "dial": ["511"],
      "timeout": 10000
    },
    {
      "dial": ["512", "513"]
    }
  ],
  "pickup": 1,
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T08:29:46.74Z",
    "lwt": "2019-08-28T08:29:46.74Z"
  }
}

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

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

Запрос

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

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

PATCH /rest/v1/uc/sipgroups/ba18a3e4-016c-d758-54da-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

group entity

Ответ

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

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

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

{
  "id": "ba18a3e4-016c-d758-54da-50e54938780c",
  "phonenumber": "500",
  "type": "parallel",
  "dialplan": [
    {"dial": ["511"]},
    {"dial": ["512"]},
    {"dial": ["513"]}
  ],
  "pickup": 1,
  "opts": {
    "title": "Отдел маркетинга",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T08:29:46.74Z",
    "lwt": "2019-09-08T12:38:24.39Z"
  }
}

Удаление группового номера

Запрос

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

DELETE /rest/v1/uc/sipgroups/ba18a3e4-016c-d758-54da-50e54938780c HTTP/1.1

Ответ

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

HTTP/1.1 204 No Content

Поиск идентификатора группового номера

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

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

Запрос

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

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

"500"

Ответ

Пример успешного ответа

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "ba18a3e4-016c-d758-54da-50e54938780c"
]

Пример неуспешного ответа

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}