User Tools

Site Tools


api:sbc:host:get

API : SBC Host Get

Introduction

This request will return an internal hosts that the SBC relays traffic to and accepts traffic from.

Request

URL https://api.telecomx.dk/sbc/host/HOST_ID
Method GET
Access level RESELLER_ADMIN with TELE feature, or ADMIN.
Param HOST_ID Id of the host (IP address).

Query examples

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

Response

The response is a host object.

Peer 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.
serviceMode Boolean True if host is down for service (PBX type only).
type String Type of server: gw, trunk, pbx, tngw, sbc, development, webrtc, job.

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

Response example

{
  _id: '3.1.1.1',
  hostname: 'siptrunk23.telecomx.dk',
  purpose: 'SIP trunk server, part of primary cluster',
  type: 'trunk'
}
{
  _id: '213.83.176.40',
  hostname: 'pbx1.telecomx.dk',
  purpose: 'Hosted PBX',
  pbxCluster: 1,
  serviceMode: false,
  type: 'pbx'
}

Errors

Error code Message Description
400 bad_request Id not found in request URI
404 id Host not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/sbc/host/get.txt · Last modified: 2023/10/30 21:38 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki