Selector meetings (selectors)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new selector
Request
Field description: selector entity
POST /rest/v1/uc/selectors HTTP/1.1
Content-Type: application/json; charset=utf-8
selector entity
Response
Field description: selector entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
"state": "waiting"
}
Getting the list of selectors
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: id, name, login, phonenumber, reg, iduser, opts.modextin, opts.modextout, opts.trunks, ext.lwt, ext.ct. |
|
|
Offset in the list of resources to output. |
|
|
Maximum number of resources in the list. |
|
|
Sorting order of resources in the list. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/selectors?offset=0&limit=2 HTTP/1.1
Response
Field description: selector entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
"state": "waiting",
"calldurationsec": 0,
"calltimeout": 20,
"displayname": "SelectorAAA",
"enabled": false,
"timestartutc": "2019-09-23 14:30",
"topology_mode": "topology",
"comment": "",
"default_mic": true,
"default_recall": true,
"default_spk": true
},
{
"id": "d713088d-016d-5d72-ae04-50e54938780c",
"state": "waiting",
"calldurationsec": 300,
"calldurationsec": 20,
"displayname": "SelectorBBB",
"enabled": false,
"timestartutc": "2019-09-23 09:30",
"topology_mode": "abonent",
"comment": "test",
"default_mic": true,
"default_recall": true,
"default_spk": true
}
]
Getting selector data
Request
| Name | Type | Description |
|---|---|---|
|
|
List of fields to output. |
|
|
Transformation of composite fields to flat form. |
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c HTTP/1.1
Response
Field description: selector entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
"state": "waiting",
"calldurationsec": 0,
"calltimeout": 20,
"displayname": "SelectorAAA",
"enabled": false,
"timestartutc": "2019-09-23 14:30",
"topology_mode": "topology",
"comment": "",
"default_mic": true,
"default_recall": true,
"default_spk": true
}
Modifying selector data
Fields prohibited for modification: id
Request
Field description: selector entity
PATCH /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8
selector entity
Response
Field description: selector entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "2c51f8a2-016d-5d72-d44a-50e54938780c",
"state": "waiting",
"calldurationsec": 300,
"calltimeout": 20,
"displayname": "Hello World",
"enabled": true,
"timestartutc": "2019-09-23 14:30",
"topology_mode": "abonent",
"comment": "test",
"default_mic": true,
"default_recall": true,
"default_spk": true
}
Contents (child composite resources)
-
Child: Participants
-
Child: Votings
-
Child: Topology
See also
-
API /rest/v1/fs/targets/selector – managing recording files for pre-playback in selectors.