Table of Contents

API : SBC Hosts List

Introduction

This request will return a list of all the internal hosts that the SBC relays traffic to and accepts traffic from.

Request

URL https://api.telecomx.dk/sbc/host
Method GET
Access level RESELLER_ADMIN with TELE feature, or ADMIN.

Query examples

https://api.telecomx.dk/sbc/host

Response

The response is an array of hosts.

Host object (JSON)
_id String IP address of the host.
hostname String Hostname of the host.
purpose String What the host is used for.
pbxCluster Number Id of the PBX cluster the host belongs to. Only on pbx hosts.
serviceMode Boolean True if host is down for service.
type String Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job, voicemail.

Note that properties holding no value may be omitted from the object.

Response example

[
  {
    "_id": "203.0.113.10",
    "hostname": "siptrunk1.example.com",
    "purpose": "SIP trunk server, part of primary cluster",
    "type": "trunk"
  },
  {
    "_id": "203.0.113.20",
    "hostname": "pbx1.example.com",
    "purpose": "Hosted PBX",
    "pbxCluster": 1,
    "serviceMode": false,
    "type": "pbx"
  }
]

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>