API : TCE box List

Introduction

This request will return the list of TCE boxes a customer has.

Request

URL	https://api.telecomx.dk/tce
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER or ADMIN
Query	customer	`[optional]` Id of customer to return TCE boxes for, defaults to current users customer.
	offset	`[optional]` Index of the first TCE box to return, default 0.
	limit	`[optional]` The number of TCE boxes to return, default 100, min 1, max 500.
	filter	`[optional]` To filter the TCE boxes, this can be used. IP address and MAC address is searched.
	full	`[optional]` If true, complete TCE box settings object will be returned instead of the condensed version.

Query examples

https://api.telecomx.dk/tce
https://api.telecomx.dk/tce?customer=12345789012457890ABCD&filter=523&offset=10&limit=25&full=true

Response

JSON object
offset	Index of the first TCE box returned.
limit	Number of TCE boxes to return. Note that the actual number of TCE boxes returned may be lower.
total	Number of TCE boxes that can be returned when offset and limit is not considered. This is to be used for paging through the data.
tces	Array of TCE boxes, see definition below

TCE box object (JSON)
_id	String	MAC address of the TCE box.
publicIp	String	Public IP address the box is located at, as reported by the box.
ipAddress	String	Local IP address the box is assigned, either manually or by DHCP.
lastSeen	Date	Time and date when the TCE box was last seen.

TCE box object if full=true (JSON)
_id	String	MAC address of the TCE box.
publicIp	String	Public IP address the box is located at, as reported by the box.
lastSeen	Date	Time and date when the TCE box was last seen.
ipMode	String	IP mode: DHCP (IP address is assigned by DHCP server - default) or MANUEL (specified).
ipAddress	String	Local IP address the box is assigned.
ipSubnet	String	IP Subnet IP subnet mask (if ipMode is MANUEL).
ipGateway	String	IP default gateway address (if ipMode is MANUEL).
ipDns	String	IP address of DNS server (id ipMode is MANUEL).
pbxIp	String	IP address of PBX.
pbxUsername	String	Username for PBX.
pbxPassword	String	Password for PBX.
rma	Boolean	True if box is defective and an RMA case has been opened.
tunnel	Number	Management tunnel port (ADMIN only).
debug	Boolean	True to enable debug logging from Call Enhancer and PC clients.
conflictDetection	Boolean	True to enable conflict resolution when multiple calls from same number entered different digits.
apps	Array	Array of apps - see definition below.

TCE box app object (JSON)
_id	Id	Unique ID of the app.
type	String	Type of app: CPR - Entry of digits for use by PC client (e.g. CPR, customer number). N2N - Number to number conversion (e.g. zip to extension). A2N - Maps callers number to a number (extension). URL - Send callers number to a URL and get the extension to transfer to back.
inboundNumber	String	Extension number to dial to call into this app.
returnNumber	String	Extension number to redirect back to when done (type=CPR only).
errorNumber	String	Extension number to redirect back to on error/missing input.
initialDelay	Number	Number of seconds to wait after receiving call, before playing beep and receiving digits. Default 1 second, increase for PBX'es that needs more time to setup audio e.g. due to re-invites.
timeout	Number	Number of seconds to wait for entry of digits before transferring to errorNumber, default 15 (CPR, N2N only).
cprLength	Number	Number of digits to be entered, 0-25. If 0 then no entry is required, instead callers a-number is auto-entered (CPR only).
n2nLength	Number	Number of digits to be entered (N2N only).
n2nTable	Array	Array of number to number conversions (N2N only).
n2nTable[x].from	String	Number to convert… (N2N only).
n2nTable[x].to	String	Number/extension to convert to (N2N only).
a2nTable	Array	Array of A-number to number conversions (A2N only).
a2nTable[x].from	String	A-Number to convert… (A2N only).
a2nTable[x].to	String	Number/extension to convert to (A2N only).
url	String	URL to call to retreive the number/extension to transfer the caller to. Inject the callers phone number as '{NUMBER}' into the URL.

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

Example - normal

{
  offset: 10,
  limit: 10,
  total: 23,
  tces:
  [
    {
      _id: '1234567890AB',
      publicIp: '213.83.176.254',
      ipAddress: '192.168.1.23',
      lastSeen: '2016-03-01T12:23:45'
    },
    {
      ...
    }
  ]
}

Example - full=true

{
  offset: 10,
  limit: 10,
  total: 23,
  tces:
  [
    {
      _id: '1234567890AB',
      publicIp: '213.83.176.254',
      lastSeen: '2016-03-01T12:23:45',
      ipMode: 'MANUEL',
      ipAddress: '192.168.1.23',
      ipSubnet: '255.255.255.0',
      ipGateway: '192.168.1.1',
      ipDns: '8.8.8.8',
      pbxIp: '192.168.1.20',
      pbxUsername: 'fhe6482gdhrt4628',
      pbxPassword: '2hg586uejr465jfn',
      debug: false,
      conflictDetection: true,
      apps: [
        {
          _id: '12345678901234567890ABCD',
          type: 'CPR',
          inboundNumber: '501',
          returnNumber: '352',
          errorNumber: '300',
          initialDelay: 1,
          timeout: 15,
          cprLength: 10
        },
        {
          _id: '12345678901234567890ABCE',
          type: 'N2N',
          inboundNumber: '502',
          errorNumber: '301',
          initialDelay: 1,
          timeout: 10,
          n2nLength: 4,
          n2nTable: [
            { from: '2300', to: '370' },
            { from: '4300', to: '371' },
            { from: '1000-2999', to: '372' }
          ]
        }
      ]
    },
    ...
  ]
}

Errors

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

WIKI

Table of Contents

API : TCE box List

Introduction

Request

Query examples

Response

Example - normal

Example - full=true

Errors