Agents
Retrieve a collection of ring group agents.
Authorizations
Path parameters
idall ofRequired
The unique ID of ring group.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
4XX
Error
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.
Authorizations
Path parameters
idall ofRequired
The unique ID of ring group.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Body
Responses
200
OK
4XX
Error
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 information of ring group agent.
Authorizations
Path parameters
idall ofRequired
The unique ID of ring group.
stringOptionalExample:
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
agent_numberstring · min: 3 · max: 64RequiredPattern:
The extension number.
[0-9]{3,64}
Responses
200
OK
application/json
4XX
Error
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
}