Call park groups

PreviousCall park NextDestroy

Was this helpful?

List call park groups

get

/call_park_groups

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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

skipinteger · int32 · default: 0

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

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/call_park_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "recall_to": "USER_ONLY",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Create a call park group

Create a new call park group.

post

/call_park_groups

Authorizations

Body

namestring · min: 1 · max: 64

The name of call park group

recall_tostring · enum

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.

Options: USER_ONLY, USER_FIRST_THEN_RING_GROUP, RING_GROUP_ONLY

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.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_park_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "recall_to": "USER_ONLY",
    "ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created call park group

Retrieve a call park group

Retrieves details of a call park group.

get

/call_park_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of call park group.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/call_park_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "recall_to": "USER_ONLY",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update an call park group.

post

/call_park_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of call park group.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of call park group

recall_tostring · enum

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.

Options: USER_ONLY, USER_FIRST_THEN_RING_GROUP, RING_GROUP_ONLY

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.

The unique ID of the resource.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_park_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "recall_to": "USER_ONLY",
    "ring_group_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
  }'

200

4XX

No body

Updated call park group