Get Phones

User Guide > Resources > Get Phones

This request returns a list of phone accounts

Resource

GET /phones

Parameters

Common Search Parameters

Name Type Description

where

[String]

Additional search fields. The field user is supported: where=user=[OID of UserProfile]

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
-user → the user that owns this phone
-user.userLicense → is user licensed
-user.person → user’s person object
-userName → SIP username (smartphone only)
-password → SIP password
-isRegisterd → is SIP client registered (not for smartphone)
-provisioningInfo → the provisioning info object of this phone
-provisioningInfo.macAddress → the provisioned mac address
-provisioningInfo.phoneType → the provisioned phone type
-users → phone’s softphone users
-phoneNumber → phone number (smartphone only)
-lines → phone lines that contain this phone

Payload

None

Response

Object Response < XCCLicensedPhone >

Context

Authorization

User

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/phones
Response
{
    "data": [
        {
            "object": {
                "active": false,
                "commonName": "Toestel (3)",
                "oid": "1932823",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1932823",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Toestel (4)",
                "oid": "1932835",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1932835",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Toestel (5)",
                "oid": "1932840",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1932840",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Toestel (6)",
                "oid": "1932845",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1932845",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "HELP",
                "oid": "1932872",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1932872",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Softphone beheerder",
                "oid": "1057482",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1057482",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Softphone van Haas Henk",
                "oid": "1626799",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1626799",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Yealink",
                "oid": "1626929",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1626929",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Toestel",
                "oid": "1659352",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1659352",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Toestel (2)",
                "oid": "1659357",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1659357",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Haas Henk (smartphone)",
                "oid": "1626817",
                "objectType": "XCCExternalPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1626817",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": false,
                "commonName": "Jules de Tank (smartphone)",
                "oid": "1626868",
                "objectType": "XCCExternalPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1626868",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "active": true,
                "commonName": "Toestel (7)",
                "oid": "1934874",
                "objectType": "XCCPhone"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "http://localhost:8080/api/v1/master/phones/1934874",
                    "method": "GET"
                }
            ]
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "http://localhost:8080/api/v1/master/phones",
                "method": "GET"
            }
        ]
    }
}