List Peers

User Guide > Resources > List Peerss

This request returns a list of peers.

A peer is created for each phone/trunk in the sip server.

Resource

GET /peers

Parameters

None

Payload

None

Response

List Response < Peer >

Context

Authorization

Administrator

Errors

Common Errors

Examples

List all active channels

Request
GET https://xelion.nl/api/v1/master/peers
Response
{
    "data": [
        {
            "object": {
                "name": "_Test",
                "object": {
                    "commonName": "_Test",
                    "oid": "1033697",
                    "objectType": "XCCTrunk"
                },
                "status": "Registered",
                "registrationDate": "2022-09-21 10:32:48",
                "ipAddress": "15.12.4.2"
            }
        },
        {
            "object": {
                "name": "_wes",
                "object": {
                    "commonName": "_wes",
                    "oid": "1651244",
                    "objectType": "XCCPhone"
                },
                "status": "Registered",
                "registrationDate": "2022-09-21 10:33:27",
                "ipAddress": ""
            }
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://arno.xelion.nl/api/v1/master/peers",
                "method": "GET"
            }
        ]
    }
}