Call pickup groups | PortSIP Knowledge Base

List call pickup groups

GEThttp://127.0.0.1:8888/api/call_pickup_groups

Query parameters

Response

OK

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

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

Response

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

Create a call pickup group

Create a new call pickup group.

POSThttp://127.0.0.1:8888/api/call_pickup_groups

Body

namestring

The name of call park group

descriptionstring

The description of call park group.

Response

Created call pickup group

Body

idall of

The unique ID of call pick group.

Request

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

Response

{
  "id": {}
}

Retrieve a call pickup group

Retrieves details of a call pickup group.

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

Path parameters

id*all of

The unique ID of call park group.

Response

OK

Body

idall of

The unique ID of call pick group.

namestring

The name of call park group

descriptionstring

The description of call park group.

Request

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

Response

{
  "id": {},
  "name": "text",
  "description": "text"
}

Update an call pickup group.

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

Path parameters

id*all of

The unique ID of call pick group.

Body

namestring

The name of call park group

descriptionstring

The description of call park group.

Response

Updated call pickup group

Request

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