Members

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.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

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.

The unique ID of the resource.

Body

itemsstring[]optional

Collection of member's extension number.

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

No body

OK

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.

The unique ID of the resource.

extension_numberstring · min: 3 · max: 64required

The extension number.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "display_name": "text",
  "extension_number": "text"
}

OK