Get phones of user

User Guide > Resources > Get phones of user

This request returns a list of phones of the current user.

Resource

GET /me/phones

Parameters

Common Search Parameters

Name Type Description

include

String
A comma seperated list of fields to include in the results. See Common Search Parameters

Include fields to the result. include=[included fields]
-doNotDisturb → is do not disturb on
-phoneNumber → phone number (smartphone only)
-hotDeskingDate → date of hot desked user
-provisionininfo → the provisioning info object of this phone
-provisioninginfo.macAddress → the provisioned mac address
-provisioninginfo.phoneType → the provisioned phone type
-users → users collection which only contains the potential softphone user

Payload

None

Response

List Response < Phone >

Context

Authorization

User

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/me/phones
Response
{
    "data": [
        {
            "object": {
                "active": false,
                "commonName": "Softphone van Wesley",
                "oid": "1651244",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/phones/1651244",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "test phone [wes]",
                "oid": "1811849",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/phones/1811849",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Wesley (smartphone)",
                "oid": "1858406",
                "objectType": "XCCExternalPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/phones/1858406",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/me/phones",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "https://xelion.nl/api/v1/master/me/phones?after=1858406",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "https://xelion.nl/api/v1/master/me/phones?before=1651244",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1651244",
            "nextId": "1858406"
        }
    }
}