Call Pickup

Manage call pickup functions.

List call pickup groups

get

List call pickup 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
GET /api/call_pickup_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "description": "text"
    }
  ]
}

Create a call pickup group

post

Create a new call pickup group.

Authorizations
Body
namestring · min: 1 · max: 64Optional

The name of call park group

descriptionstring · min: 1 · max: 1024Optional

The description of call park group.

Responses
201

Created call pickup group

application/json
post
POST /api/call_pickup_groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a call pickup group

get

Retrieves details of a call pickup 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
GET /api/call_pickup_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "description": "text"
}

Update an call pickup group.

post

Update an call pickup group.

Authorizations
Path parameters
idall ofRequired

The unique ID of call pick group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestring · min: 1 · max: 64Optional

The name of call park group

descriptionstring · min: 1 · max: 1024Optional

The description of call park group.

Responses
200

Updated call pickup group

No content
post
POST /api/call_pickup_groups/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
No content

Delete a call pickup group

post

Delete a call pickup group.

Authorizations
Path parameters
idall ofRequired

The unique ID of call pick group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content
post
POST /api/call_pickup_groups/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List call pickup group members

get

Retrieve a collection of call pickup group members.

Authorizations
Path parameters
idall ofRequired

The unique ID of call pick group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
get
GET /api/call_pickup_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"
    }
  ]
}

Update call pickup group member list

post

Update call pickup group member list.

Authorizations
Path parameters
idall ofRequired

The unique ID of call pick group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
itemsstring[]Optional

Collection of member's extension number.

Responses
200

OK

No content
post
POST /api/call_pickup_groups/{id}/members HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "items": [
    "text"
  ]
}
No content

Check call pickup group member

get

Check if extension is in call pickup group.

Authorizations
Path parameters
idall ofRequired

The unique ID of call pick 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

application/json
get
GET /api/call_pickup_groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "display_name": "text",
  "extension_number": "text"
}
PreviousCall ParkNextHot Desking