Call park

Retrieve call park server

Retrieve call park server information.

GEThttp://127.0.0.1:8888/api/call_park

Response

2004XX

OK

Body

application/json

enabledboolean

Enable call park server or not.

extension_numberall of

Extension number used by call park server.

recall_toenum

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.

USER_ONLYUSER_FIRST_THEN_RING_GROUPRING_GROUP_ONLY

recall_timeinteger (int32)

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.

recall_ring_group_timeinteger (int32)

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.

ring_group_idall of

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.

prompt_file_namestring

The name of the file.

prompt_file_sizeinteger (int64)

The file size in bytes.

Example: 0

prompt_file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_park', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "enabled": false,
  "extension_number": {},
  "recall_to": "USER_ONLY",
  "ring_group_id": {},
  "prompt_file_name": "text",
  "prompt_file_size": 0,
  "prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Update call park server

Update call park server

POSThttp://127.0.0.1:8888/api/call_park

Body

application/json

enabledboolean

Enable call park server or not.

extension_numberall of

Extension number used by call park server.

recall_toenum

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.

USER_ONLYUSER_FIRST_THEN_RING_GROUPRING_GROUP_ONLY

recall_timeinteger (int32)

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.

recall_ring_group_timeinteger (int32)

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.

ring_group_idall of

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.

prompt_file_idall of

The unique ID of the file.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/call_park', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();