Get external trunk numbers

User Guide > Resources > Get external trunk numbers

This request returns a list of external numbers configured on the trunks. Only numbers belonging to an active trunk are returned.

Resource

GET /trunks/external_numbers

Parameters

useAsCallerId

Optional. When true, only numbers that may be used as caller ID are returned. When false, only numbers that may not be used as caller ID are returned. When omitted, all numbers are returned.

Payload

None

Response

List Response <TrunkExtension>

Context

Authorization

Administrator

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/trunks/external_numbers

Response

{
    "data": [
        {
            "object": {
                "extension": {
                    "addressType": "Telephone",
                    "address": "888",
                    "label": "",
                    "orderNumber": 0,
                    "oid": "6056520",
                    "objectType": "TelecomAddress"
                },
                "useAsCallerId": true,
                "trunk": {
                    "commonName": "Trunk Amsterdam",
                    "oid": "6056497",
                    "objectType": "XCCTrunk"
                },
                "oid": "6056521",
                "objectType": "XCCTrunkExtension"
            }
        },
        {
            "object": {
                "extension": {
                    "addressType": "Telephone",
                    "address": "666",
                    "label": "",
                    "orderNumber": 0,
                    "oid": "6056523",
                    "objectType": "TelecomAddress"
                },
                "useAsCallerId": false,
                "trunk": {
                    "commonName": "Trunk Amsterdam",
                    "oid": "6056497",
                    "objectType": "XCCTrunk"
                },
                "oid": "6056524",
                "objectType": "XCCTrunkExtension"
            }
        },
        {
            "object": {
                "extension": {
                    "addressType": "Telephone",
                    "address": "1314",
                    "label": "",
                    "orderNumber": 0,
                    "oid": "6056532",
                    "objectType": "TelecomAddress"
                },
                "useAsCallerId": false,
                "trunk": {
                    "commonName": "Trunk Amsterdam",
                    "oid": "6056497",
                    "objectType": "XCCTrunk"
                },
                "oid": "6056533",
                "objectType": "XCCTrunkExtension"
            }
        }
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/trunks/external_numbers",
                "method": "GET"
            }
        ]
    }
}