Call Park

Manage call park functions.

Retrieve call park server

get

Retrieve call park server information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

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 ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

prompt_file_namestringOptional

The name of the file.

prompt_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

prompt_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

4XX

Error

get

/call_park

HTTPcURLJavaScriptPython

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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 ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

prompt_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/call_park

HTTPcURLJavaScriptPython

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

get

List call park groups

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/call_park_groups

HTTPcURLJavaScriptPython

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 call park group

post

Create a new call park group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestring · min: 1 · max: 64Optional

The name of call park group

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:

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 ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

201

Created call park group

application/json

4XX

Error

post

/call_park_groups

HTTPcURLJavaScriptPython

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"
}

Retrieve a call park group

get

Retrieves details of a call park group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of call park group

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:

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 ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

get

/call_park_groups/{id}

HTTPcURLJavaScriptPython

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.

post

Update an call park group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

application/json

namestring · min: 1 · max: 64Optional

The name of call park group

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:

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 ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

Updated call park group

No content

4XX

Error

post

/call_park_groups/{id}

HTTPcURLJavaScriptPython

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

post

Delete a call park group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/call_park_groups/{id}/destroy

HTTPcURLJavaScriptPython

POST /api/call_park_groups/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List call park group members

get

Retrieve a collection of call park group members.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/call_park_groups/{id}/members

HTTPcURLJavaScriptPython

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 call park group member

post

Add user member into call park group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

Responses

200

OK

No content

4XX

Error

post

/call_park_groups/{id}/members/{extension_number}

HTTPcURLJavaScriptPython

POST /api/call_park_groups/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete call park group member

post

Delete a call park group member.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

Responses

204

No Content

4XX

Error

post

/call_park_groups/{id}/members/{extension_number}/destroy

HTTPcURLJavaScriptPython

POST /api/call_park_groups/{id}/members/{extension_number}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content