Call park groups

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_idstringOptional

The unique ID of ring group.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

201

Created call park group

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

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

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idstringOptional

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_idstringOptional

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

idstringRequired

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_idstringOptional

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