Call Pickup
Manage call pickup functions.
List call pickup groups
Use the filter
query parameter to retrieve just a subset of a collection.
Use the search
query parameter to restrict the results of a request to match a search criterion.
Use the orderby
query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip
query parameter to set the number of items to skip at the start of a collection.
0
Use the top
query parameter to specify the page size of the result set.
100
OK
Error
GET /api/call_pickup_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"description": "text"
}
]
}
Create a new call pickup group.
The name of call park group
The description of call park group.
Created call pickup group
Error
POST /api/call_pickup_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
Retrieves details of a call pickup group.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
OK
Error
GET /api/call_pickup_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"description": "text"
}
Update an call pickup group.
The unique ID of call pick group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The name of call park group
The description of call park group.
Updated call pickup group
Error
POST /api/call_pickup_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}
No content
Delete a call pickup group.
The unique ID of call pick group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
No Content
Error
POST /api/call_pickup_groups/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of call pickup group members.
The unique ID of call pick group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
OK
Error
GET /api/call_pickup_groups/{id}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"display_name": "text",
"extension_number": "text"
}
]
}
Update call pickup group member list.
The unique ID of call pick group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
Collection of member's extension number.
OK
Error
POST /api/call_pickup_groups/{id}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"items": [
"text"
]
}
No content
Check if extension is in call pickup group.
The unique ID of call pick group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The extension number.
[0-9]{3,64}
OK
Not Found
GET /api/call_pickup_groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"display_name": "text",
"extension_number": "text"
}