Groups

List user groups

Get a collection of user groups.

GEThttp://127.0.0.1:8888/api/groups

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create an user group

Create a new user group.

POSThttp://127.0.0.1:8888/api/groups

Body

application/json

namestring

The name of user group.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

descriptionstring

The description of user group.

Response

2014XX

Created user group

Body

application/json

idall of

The unique ID of user group.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve an user group

Retrieves the properties of an user group.

GEThttp://127.0.0.1:8888/api/groups/{id}

Path parameters

id*all of

The unique ID of user group.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of user group.

namestring

The name of user group.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

descriptionstring

The description of user group.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update an user group.

Update an user group

POSThttp://127.0.0.1:8888/api/groups/{id}

Path parameters

id*all of

The unique ID of user group.

Body

application/json

namestring

The name of user group.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

descriptionstring

The description of user group.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/groups/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();