Agents

List ring group agents

get

Retrieve a collection of ring group agents.

Authorizations
Path parameters
idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/ring_groups/{id}/agents HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "extension_number": "text",
      "display_name": "text",
      "skill_level": 1
    }
  ]
}

Update ring group member list

post

Update ring group member list.

Authorizations
Path parameters
idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
Responses
200
OK
post
POST /api/ring_groups/{id}/agents HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "items": [
    {
      "extension_number": "text",
      "skill_level": 1
    }
  ]
}

No content

Retrieve ring group agent details.

get

Retrieve information of ring group agent.

Authorizations
Path parameters
idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
agent_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}
Responses
200
OK
application/json
get
GET /api/ring_groups/{id}/agents/{agent_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "extension_number": "text",
  "display_name": "text",
  "skill_level": 1
}