Agents

List ring group agents

Retrieve a collection of ring group agents.

GEThttp://127.0.0.1:8888/api/ring_groups/{id}/agents
Path parameters
id*all of

The unique ID of ring group.

Response

OK

Body
itemsarray of object
Request
const response = await fetch('http://127.0.0.1:8888/api/ring_groups/{id}/agents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "items": [
    {
      "extension_number": {},
      "display_name": {}
    }
  ]
}

Update ring group member list

Update ring group member list.

POSThttp://127.0.0.1:8888/api/ring_groups/{id}/agents
Path parameters
id*all of

The unique ID of ring group.

Body
itemsarray of object

Collection of agents.

Response

OK

Request
const response = await fetch('http://127.0.0.1:8888/api/ring_groups/{id}/agents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Retrieve ring group agent details.

Retrieve information of ring group agent.

GEThttp://127.0.0.1:8888/api/ring_groups/{id}/agents/{agent_number}
Path parameters
id*all of

The unique ID of ring group.

agent_number*string

The extension number.

Pattern: [0-9]{3,64}
Response

OK

Body
extension_numberall of

The extension number of agent.

display_nameall of

The display name of agent.

skill_levelinteger (int32)

The skill level of agent in ring group.
Only valid when ring_strategy is skill based.

Request
const response = await fetch('http://127.0.0.1:8888/api/ring_groups/{id}/agents/{agent_number}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "extension_number": {},
  "display_name": {}
}
PreviousRing groupsNextDestroy