Call park

PreviousDestroy NextCall park groups

Retrieve call park server

get

Retrieve call park server information.

Authorizations

Responses

200

application/json

4XX

Error

get

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

post

Update call park server

Authorizations

Body

enabledbooleanOptional

Enable call park server or not.

extension_numberall ofOptional

Extension number used by call park server.

string · min: 3 · max: 64Optional

The extension number.

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

recall_tostring · enumOptional

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.

Possible values:

recall_timeinteger · int32 · min: 60 · max: 900Optional

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.

Default: 300

recall_ring_group_timeinteger · int32 · min: 60 · max: 900Optional

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.

Default: 300

ring_group_idall ofOptional

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.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

prompt_file_idall ofOptional

The unique ID of the file.