Call park groups

List call park groups

GEThttp://127.0.0.1:8888/api/call_park_groups

Query parameters

Response

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

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

Response

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

Create a call park group

Create a new call park group.

POSThttp://127.0.0.1:8888/api/call_park_groups

Body

namestring

The name of call park group

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

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.

Response

Created call park group

Body

idall of

The unique ID of call park group.

Request

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

Response

{
  "id": {}
}

Retrieve a call park group

Retrieves details of a call park group.

GEThttp://127.0.0.1:8888/api/call_park_groups/{id}

Path parameters

id*all of

The unique ID of call park group.

Response

Body

idall of

The unique ID of call park group.

namestring

The name of call park group

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

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.

Request

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

Response

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

Update an call park group.

POSThttp://127.0.0.1:8888/api/call_park_groups/{id}

Path parameters

id*all of

The unique ID of call park group.

Body

namestring

The name of call park group

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

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.

Response

Updated call park group

Request

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

PreviousCall park NextDestroy