Functional call groups (sipkits)

Table of Contents

Requests

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`POST`	`/rest/v1/uc/sipkits`	Creating a new group
`GET`	`/rest/v1/uc/sipkits`	Getting the list of groups
`GET`	`/rest/v1/uc/sipkits/<id>`	Retrieving group data
`PATCH`	`/rest/v1/uc/sipkits/<id>`	Changing group data
`DELETE`	`/rest/v1/uc/sipkits/<id>`	Deleting a group

POST

/rest/v1/uc/sipkits

Creating a new group

GET

/rest/v1/uc/sipkits

Getting the list of groups

GET

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

Retrieving group data

PATCH

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

Changing group data

DELETE

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

Deleting a group

Creating a new group

Request

Field Description: sipkit entity

Request example

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

sipkit entity

Response

Field Description: sipkit entity

Response example

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"
  }
}

Getting the list of groups

Request

Table 1. Request parameters
Name	Type	Description
`filter`	`object`	Filter by field values.
`mask`	`str`	List of fields to output. Available fields for output: id, name, type, details, enabled, cascade, priority, opts.title, ext.lwt, ext.ct.
`offset`	`int`	Offset in the list of resources to be issued.
`limit`	`int`	The maximum number of resources in the list.
`order`	`array<object\|str>`	The sort order of the resources in the list.
`flat`	`bool`	Conversion to flat form of composite fields.

Details about the format of GET request parameters

Request example

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

Response

Field Description: sipkit entity

Response example

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"
    }
  }
]

Retrieving group data

Request

Table 2. Request parameters
Name	Type	Description
`mask`	`str`	A list of fields to output.
`flat`	`bool`	Conversion to flat form of composite fields.

Request example

GET /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1

Response

Field Description: sipkit entity

Response example

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"
  }
}

Changing group data

Fields prohibited for modification: id

Request

Field Description: sipkit entity

Request example

PATCH /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1
Content-Type: application/json; charset=utf-8

sipkit entity

Response

Field Description: sipkit entity

Response example

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"
  }
}

Deleting a group

Request

Request example

DELETE /rest/v1/uc/sipkits/182dc715-0186-7858-a770-7cd30a921f58 HTTP/1.1

Response

Response example

HTTP/1.1 204 No Content