Call pickup groups

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 · int32 · default: 0optional

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: 100optional

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

Responses
curl -L \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "description": "text"
    }
  ]
}

OK

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
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"
  }'
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created call pickup group

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.

The unique ID of the resource.

Responses
curl -L \
  --url 'https://HOSTNAME:8887/api/call_pickup_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "description": "text"
}

OK

Update an call pickup group.

post

Update an call pickup group.

Authorizations
Path parameters
idall ofrequired

The unique ID of call pick group.

The unique ID of the resource.

Body
namestring · min: 1 · max: 64optional

The name of call park group

descriptionstring · min: 1 · max: 1024optional

The description of call park group.

Responses
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"
  }'
No body

Updated call pickup group

PreviousDestroyNextDestroy

Was this helpful?