Groups

List user groups

get

Get a collection of user 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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Create an user group

post

Create a new user group.

Authorizations

Body

namestring · min: 1 · max: 64optional

The name of user group.

outbound_caller_idsobject[]optional

A collection of outbound caller IDs.

descriptionstring · max: 1024optional

The description of user group.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created user group

Retrieve an user group

get

Retrieves the properties of an user group.

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Update an user group.

post

Update an user group

Authorizations

Path parameters

idall ofrequired

The unique ID of user group.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64optional

The name of user group.

outbound_caller_idsobject[]optional

A collection of outbound caller IDs.

descriptionstring · max: 1024optional

The description of user group.

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

No body

OK