Call Park
Manage call park functions.
Retrieve call park server information.
GET /api/call_park HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"enabled": true,
"extension_number": "text",
"recall_to": "USER_ONLY",
"recall_time": 300,
"recall_ring_group_time": 300,
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"prompt_file_name": "text",
"prompt_file_size": 0,
"prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}
Update call park server
Enable call park server or not.
Extension number used by call park server.
The extension number.
[0-9]{3,64}
Select how the park server forwards the call when the parked call is not picked up in the Recall Time. The forwarding destination can be an extension or a ring group. Can be either:
USER_ONLY
:USER_FIRST_THEN_RING_GROUP
:RING_GROUP_ONLY
:
When set to USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
, ring_group_id
must also be specified.
Set how long the call can be parked on the park server, in seconds. After this time, the park server needs to forward the call to the preset extension or ring group according to the settings. The default value is 300 seconds, the minimum value is 60 seconds, and the maximum value is 900 seconds.
300
Set how long the call can be parked on the park server, in seconds. If the call is not picked up after this time, the park server needs to forward the call to the preset ring group according to the settings. The default value is 300 seconds, the minimum value is 60 seconds, and the maximum value is 90 seconds.
300
The unique ID of ring group.
Select a Ring Group as the Recall destination.
Only valid when the value of recall_to
is USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/call_park HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"enabled": true,
"extension_number": "text",
"recall_to": "USER_ONLY",
"recall_time": 300,
"recall_ring_group_time": 300,
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"prompt_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
No content
List call park 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
GET /api/call_park_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"recall_to": "USER_ONLY",
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
]
}
Create a new call park group.
The name of call park group
Select how the park server forwards the call when the parked call is not picked up in the Recall Time. The forwarding destination can be an extension or a ring group. Can be either:
USER_ONLY
:USER_FIRST_THEN_RING_GROUP
:RING_GROUP_ONLY
:
When set to USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
, ring_group_id
must also be specified.
The unique ID of ring group.
Select a Ring Group as the Recall destination.
Only valid when the value of recall_to
is USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/call_park_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"name": "text",
"recall_to": "USER_ONLY",
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
Retrieves details of a call park group.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
GET /api/call_park_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"recall_to": "USER_ONLY",
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
Update an call park group.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The name of call park group
Select how the park server forwards the call when the parked call is not picked up in the Recall Time. The forwarding destination can be an extension or a ring group. Can be either:
USER_ONLY
:USER_FIRST_THEN_RING_GROUP
:RING_GROUP_ONLY
:
When set to USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
, ring_group_id
must also be specified.
The unique ID of ring group.
Select a Ring Group as the Recall destination.
Only valid when the value of recall_to
is USER_FIRST_THEN_RING_GROUP
or RING_GROUP_ONLY
.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/call_park_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"name": "text",
"recall_to": "USER_ONLY",
"ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
No content
Delete a call park group.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
POST /api/call_park_groups/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of call park group members.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
GET /api/call_park_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"
}
]
}
Add user member into call park group.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The extension number.
[0-9]{3,64}
POST /api/call_park_groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete a call park group member.
The unique ID of call park group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The extension number.
[0-9]{3,64}
POST /api/call_park_groups/{id}/members/{extension_number}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content