Call Pickup

Manage call pickup functions.

List call pickup groups

get

List call pickup 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_pickup_groups

HTTPcURLJavaScriptPython

GET /api/call_pickup_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "name": null,
      "description": null
    }
  ]
}

Create a call pickup group

post

Create a new call pickup 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

descriptionstring · min: 1 · max: 1024Optional

The description of call park group.

Responses

201

Created call pickup group

application/json

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/call_pickup_groups

HTTPcURLJavaScriptPython

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

{
  "name": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a call pickup group

get

Retrieves details of a call pickup 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

descriptionstring · min: 1 · max: 1024Optional

The description of call park group.

4XX

Error

get/call_pickup_groups/{id}

HTTPcURLJavaScriptPython

GET /api/call_pickup_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "description": null
}

Update an call pickup group.

post

Update an call pickup 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

descriptionstring · min: 1 · max: 1024Optional

The description of call park group.

Responses

200

Updated call pickup group

No content

4XX

Error

post/call_pickup_groups/{id}

HTTPcURLJavaScriptPython

POST /api/call_pickup_groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": null,
  "description": null
}

No content

Delete a call pickup group

post

Delete a call pickup group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

4XX

Error

post/call_pickup_groups/{id}/destroy

HTTPcURLJavaScriptPython

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

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

4XX

Error

get/call_pickup_groups/{id}/members

HTTPcURLJavaScriptPython

GET /api/call_pickup_groups/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "display_name": null,
      "extension_number": null
    }
  ]
}

Update call pickup group member list

post

Update call pickup group member list.

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

itemsstring[]Optional

Collection of member's extension number.

Responses

200

OK

No content

4XX

Error

post/call_pickup_groups/{id}/members

HTTPcURLJavaScriptPython

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: 23

{
  "items": [
    "xxx",
    "yyy"
  ]
}

No content

Check call pickup group member

get

Check if extension is in call pickup group.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

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

idstringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

display_namestring · max: 1024Optional

The display name of user.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

Pattern: [0-9]{3,64}

404

Not Found

get/call_pickup_groups/{id}/members/{extension_number}

HTTPcURLJavaScriptPython

GET /api/call_pickup_groups/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "display_name": null,
  "extension_number": null
}