Groups

PreviousExtension numbers NextDestroy

Was this helpful?

List user groups

Get a collection of user groups.

get

/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

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/groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Create an user group

Create a new user group.

post

/groups

Authorizations

Body

namestring · min: 1 · max: 64

The name of user group.

descriptionstring · max: 1024

The description of user group.

outbound_caller_idsobject[]

A collection of outbound caller IDs.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"outbound_caller_ids":[{"provider_id":"NzAwNTUxOTA5NzczMTQ4MTYw"}]}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created user group

Retrieve an user group

Retrieves the properties of an user group.

get

/groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

4XX

{
  "name": "text",
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "outbound_caller_ids": [
    {
      "description": "text",
      "caller_id": "text",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Update an user group.

Update an user group

post

/groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

Body

namestring · min: 1 · max: 64

The name of user group.

descriptionstring · max: 1024

The description of user group.

outbound_caller_idsobject[]

A collection of outbound caller IDs.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"outbound_caller_ids":[{"provider_id":"NzAwNTUxOTA5NzczMTQ4MTYw"}]}'

200

4XX

No body