Agents

PreviousRing groups NextDestroy

Was this helpful?

List ring group agents

Retrieve a collection of ring group agents.

get

/ring_groups/{id}/agents

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

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

Update ring group member list

Update ring group member list.

post

/ring_groups/{id}/agents

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

Body

itemsobject[]

Collection of agents.

Responses

cURL

JavaScript

Python

HTTP

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":[{"skill_level":1}]}'

200

4XX

No body

Retrieve ring group agent details.

Retrieve information of ring group agent.

get

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

Authorizations

Path parameters

idall ofrequired

The unique ID of ring group.

agent_numberstring · min: 3 · max: 64required

The extension number.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

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