Call pickup groups

PreviousDestroy NextDestroy

Was this helpful?

List call pickup groups

get

/call_pickup_groups

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Create a call pickup group

Create a new call pickup group.

post

/call_pickup_groups

Authorizations

Body

namestring · min: 1 · max: 64

The name of call park group

descriptionstring · min: 1 · max: 1024

The description of call park group.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created call pickup group

Retrieve a call pickup group

Retrieves details of a call pickup group.

get

/call_pickup_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of call park group.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Update an call pickup group.

post

/call_pickup_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of call pick group.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of call park group

descriptionstring · min: 1 · max: 1024

The description of call park group.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text"
  }'

200

4XX

No body

Updated call pickup group