Call park groups

List call park groups

get

List call park groups

Authorizations
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
get
/call_park_groups
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
Body
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 the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
201

Created call park group

application/json
post
/call_park_groups
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
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
get
/call_park_groups/{id}
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
Path parameters
idall ofRequired

The unique ID of call park group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
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 the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

Updated call park group

No content
post
/call_park_groups/{id}
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
PreviousCall parkNextDestroy