Agents

List ring group agents

get

Retrieve a collection of ring group agents.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/ring_groups/{id}/agents

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of ring group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

Responses

200

OK

No content

4XX

Error

post

/ring_groups/{id}/agents

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

extension_numberall ofOptional

The extension number of agent.

string · min: 3 · max: 64Optional

The extension number.

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

display_nameall ofRead-onlyOptional

The display name of agent.

string · max: 1024Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

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

Default: 1

4XX

Error

get

/ring_groups/{id}/agents/{agent_number}

HTTPcURLJavaScriptPython

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
}