Agents

List ring group agents

get

Retrieve a collection of ring group agents.

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ring_groups/{id}/agents' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

OK

Update ring group member list

post

Update ring group member list.

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

The unique ID of the resource.

Body

itemsobject[]optional

Collection of agents.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/ring_groups/{id}/agents' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "extension_number": "text",
        "skill_level": 1
      }
    ]
  }'

200

4XX

200

No body

OK

Retrieve ring group agent details.

get

Retrieve information of ring group agent.

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

The unique ID of the resource.

agent_numberstring · min: 3 · max: 64required

The extension number.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/ring_groups/{id}/agents/{agent_number}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "extension_number": "text",
  "display_name": "text",
  "skill_level": 1
}

OK