latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Call Park

Retrieve call park server

Retrieve call park server information.

get/call_park

Response

OK

enabledboolean

Enable call park server or not.

extension_numberstring

The extension number.

recall_to'USER_ONLY' | 'USER_FIRST_THEN_RING_GROUP' | 'RING_GROUP_ONLY'

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.

recall_timeinteger

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

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_idstring

The unique ID of the resource.

prompt_file_namestring

The name of the file.

prompt_file_sizeinteger

The file size in bytes.

prompt_file_urlstring

The relative path to file url for file downloading.

Example response

{
  "ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "prompt_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}