API : Presence Proxy Get

Introduction

This request will return the settings for a Presence Proxy server.

Request

URL	https://api.telecomx.dk/presenceproxy/PRESENCE_PROXY_ID
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER or ADMIN
Param	PRESENCE_PROXY_ID	Id of the Presence Proxy server (24-char hex string).

Query examples

https://api.telecomx.dk/presenceproxy/12345678901234567890ABCD

Response

JSON object
_id	ObjectId	Unique ID of the presence proxy.
customer	ObjectId	Id of customer.
license	String	License model: TCX1 (up to 25 users on TCX network) TCX2 (over 25 users on TCX network) OTHER1 - up to 25 users on 3rd party network OTHER2 - over 25 users on 3rd party network
ipAddress	String	IP address to listen for call events (on proxy server).
ipPort	Number	Port number to listen for call events (on proxy server).
accessToken	String	Auto-generated access token, required by the Presence Proxy to fetch its configuration.
oipServer	String	IP address of the OIP server.
calendarMessage	String	Message to show in calendar appointment when busy on mobile phone.
calendarRemote	Boolean	If remote caller/callee's number should be appended to the calendarMessage.
calendarState	String	State to set on user when busy: UNKNOWN, AVAILABLE, MEETING, OCCUPIED, NOT_AVAILABLE, ABSENT.
calendarLength	Number	Duration of the calendar item in minutes, default 30.
provider	String	Name of provider of call events: TELECOMX, TDC, TELENOR, TELIA, 3, OTHER.
providerSettings	Object	Provider specific configuration - currently only for Telenor.
providerSettings.username	String	Username for Telenor long polling interface.
providerSettings.password	String	Password for Telenor long polling interface.
providerSettings.host	String	Host name and port for Telenor long polling interface.
providerSettings.pni	String	PNI code for Telenor.
users	Array	List of mobile users.
users[x].user	String	User name, usually extension.
users[x].pin	String	User pin or password.
users[x].number	String	Users 8-digit mobile phone number.
synced	Date	Date and time when the presence proxy server last fetched it's configuration.

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

Example

{
  _id: ObjectId('12345678901234567890ABCD'),
  customer: ObjectId('12345678901234567890BBBB'),
  license: 'TCX1',
  ipAddress: '192.168.1.10',
  ipPort: 4444,
  accessToken: '8fhyyuvhewfuvhwru329eu37etudsgew8gdd',
  oipServer: '192.168.1.10',
  calendarMessage: 'Mobile busy',
  calendarRemote: true,
  calendarState: 'OCCUPIED',
  calendarLength: 30,
  provider: 'TELENOR',
  providerSettings: {
    username: 'ew238feghjie2',
    password: 'sdw2hyufbjkw',
    host: 'http://12.34.56.78:1234'
  },
  users: [
    {
      user: '201',
      pin: '1234',
      number: '81808888'
    },
    ...
  ],
  synced: ISODate('2016-01-01T00:00:00.000Z')
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	id	Presence proxy not found
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Presence Proxy Get

Introduction

Request

Query examples

Response

Example

Errors