API : TCE : PC client List

Introduction

This request will return the list of PC clients on a TCE box.

Request

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

Query examples

https://api.telecomx.dk/tce/123456789012/cpr
https://api.telecomx.dk/tce/123456789012/cpr?filter=523&offset=10&limit=25&full=true

Response

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

PC client object (JSON)
_id	String	Configuration ID.
box	String	MAC address of TCE box the PC client belongs to.
extension	String	Extension number of the phone that the PC client is paired with.
lastSeen	Date	Time and date when the PC client last fetched it's configuration.

PC client if full=true (JSON)
_id	String	Configuration ID.
box	String	MAC address of TCE box the PC client belongs to.
extension	String	Extension number of the phone that the PC client is paired with.
usePublic	Boolean	True to use public IP address of TCE box instead of local IP address.
portOverride	Number	Port number to use instead of default port 80 (only available if usePublic is true).
copyToClipboard	Boolean	True to copy digits to clipboard when call is answered.
popup	Boolean	True to popup the application when call is answered.
alwaysOnTop	Boolean	True to keep PC client on top.
autoStart	Boolean	True to launch PC client on Windows login.
sendKeys	Object	Settings for send keystrokes - if used, null if not.
sendKeys.enable	Boolean	True to send keystrokes to 3'rd party application.
sendKeys.mode	String	ANSWER - send keystrokes when call is answered. RING - send keystrokes when phone rings.
sendKeys.toActiveWindow	Boolean	True to send keystrokes to the active window (mutually exclusive with appName).
sendKeys.appName	String	Processname of application to send keystrokes to, with/without lastname.
sendKeys.autoIT	Boolean	True to send keystrokes using autoIT instead of native method.
sendKeys.delay	Number	Number of milliseconds to wait before keystrokes are sent.
sendKeys.maxWindow	Boolean	True to maximize, false for normal.
sendKeys.strokes	String	Keystrokes to send.
execute	Object	Settings for executing an application, null if not used.
execute.enable	Boolean	True to execute command.
execute.mode	String	ANSWER - execute when call is answered. RING - execute when phone rings.
execute.delay	Number	Number of milliseconds to wait before execution starts.
execute.command	String	Command to execute, special tags are: {CPR}, {NUMBER} and {ANUMBER}.
execute.silent	Boolean	True execute command in the background.
lastSeen	Date	Time and date when the CPR logger last fetched it's configuration.

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

Example - normal

{
  offset: 10,
  limit: 10,
  total: 23,
  tcecprs:
  [
    {
      _id: 'd4G5Ey',
      box: '12345789012',
      extension: '299',
      lastSeen: '2016-03-01T12:23:45'
    },
    {
      ...
    }
  ]
}

Example - full=true

{
  offset: 10,
  limit: 10,
  total: 23,
  tces:
  [
    {
      _id: 'd4G5Ey',
      box: '12345789012',
      extension: '299',
      usePublic: true,
      portOverride: null,
      copyToClipboard: true,
      popup: false,
      alwaysOnTop: false,
      autoStart: true,
      sendKeys: {
        enable: true,
        mode: 'ANSWER',
        toActiveWindow: false,
        appName: 'xmo',
        autoIT: false,
        delay: 500,
        maxWindow: false,
        strokes: '{F10}{CPR}{ENTER}'
      },
      log: false,
      logFile: null,
      lastSeen: '2016-03-01T12:23:45'
    },
    ...
  ]
}

Errors

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

WIKI

Table of Contents

API : TCE : PC client List

Introduction

Request

Query examples

Response

Example - normal

Example - full=true

Errors