List Presence Group

User Guide > Resources > List Presence Group

This request shows line messages, location, status and status icon of a presence group member. This information is contained in the phone line.

The object ID (OID) of the presence group is a part of the resource URL. This OID is typically retrieved by a search request.

The list is always in ascending order, which is based on the configured order number.

Resource

GET /presence/groups/<OID>[?parameters]

Parameters

Name Type Description

Name	Type	Description
`name`	String	Select information of phone lines that match this string.
`with`	String	Select information of persons that match this string.
`limit`	Integer	The maximum number of objects to return. Default: 15.
`before`	[id]	Paging: return results before the specified ID.
`after`	[id]	Paging: return results after the specified ID.

name

String

Select information of phone lines that match this string.

with

String

Select information of persons that match this string.

limit

Integer

The maximum number of objects to return. Default: 15.

before

[id]

Paging: return results before the specified ID.

after

[id]

Paging: return results after the specified ID.

Payload

None

Response

List Response < Presence >

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/presence/groups/84615436?limit=2

Response

{
    "data": [
        {
            "object": {
                "name": "Support",
                "id": "1835108",
                "status": "offline",
                "statusIcon": "statusRed",
                "message": "",
                "location": "",
                "addressable": {
                    "commonName": "Support",
                    "oid": "1775715",
                    "objectType": "X1Object"
                },
                "busy": false,
                "order": 1
            }
        },
        {
            "object": {
                "name": "Sales",
                "id": "1835138",
                "status": "offline",
                "statusIcon": "statusRed",
                "message": "",
                "location": "",
                "addressable": {
                    "commonName": "Sales",
                    "oid": "1775719",
                    "objectType": "X1Object"
                },
                "busy": false,
                "order": 2
            }
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://localhost:8080/api/v1/master/presence/groups/1835104",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "http://localhost:8080/api/v1/master/presence/groups/1835104?after=1835138",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "http://localhost:8080/api/v1/master/presence/groups/1835104?before=1835108",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1835108",
            "nextId": "1835138"
        }
    }
}