Hunt group state (hunt_runtimes)

Current servicing state of the hunt groups of the current domain across all sites: resources (operators) and waiting objects (calls, chats). Group types: sip (calls) and user (users, chats).

Requests

HTTP verb Endpoint Description

GET

/rest/v1/uc/hunt_runtimes

List of types (sip, user) with links

GET

/rest/v1/uc/hunt_runtimes/<type>

List of sections (resources, contenders) with links

GET

/rest/v1/uc/hunt_runtimes/<type>/resources

Group resources

GET

/rest/v1/uc/hunt_runtimes/<type>/contenders

Waiting objects

Domain type: worker. Unknown <type> — 404.

Group resources

Array by groups: site, id, code, title, resmode, resources (resource identifiers), resources_total, resources_online, resources_free, resources_states, banned_resources (rid, banned_by, reason), objects_cnt; for sip — also huntnum.

Example request
GET /rest/v1/uc/hunt_runtimes/sip/resources HTTP/1.1

Waiting objects

Array by groups: site, id, code, objmode, maxqtimersec (waiting time of the oldest object, seconds; null if the queue is empty), objects_cnt, objects_info (information about objects in the queue).

Example response
GET /rest/v1/uc/hunt_runtimes/sip/contenders HTTP/1.1

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

[
  {
    "site": "central",
    "id": "0f1d2c3b-0000-0000-0000-000000000001",
    "code": "support",
    "objmode": "spq",
    "maxqtimersec": null,
    "objects_cnt": 0,
    "objects_info": []
  }
]