API : Presence Proxy List

Introduction

This request will return the list of Presence proxy servers a customer has.

Request

URL	https://api.telecomx.dk/presenceproxy
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER or ADMIN
Query	customer	`[optional]` Id of customer to return presence proxy servers for, defaults to current users customer.
	offset	`[optional]` Index of the first presence proxy server to return, default 0.
	limit	`[optional]` The number of presence proxy servers to return, default 100, min 1, max 500.

Query examples

https://api.telecomx.dk/presenceproxy
https://api.telecomx.dk/presenceproxy?customer=12345789012457890ABCD&offset=10&limit=25

Response

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

Presence Proxy object (JSON)
_id	Id	Unique ID of the Presence Proxy server.
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).
provider	String	Name of provider of call events: TELECOMX, TDC, TELENOR, TELIA, 3, OTHER.
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

{
  offset: 10,
  limit: 10,
  total: 23,
  presenceProxies:
  [
    {
      _id: '1234567890123457890ABCD',
      license: 'TCX1',
      ipAddress: '192.168.1.10',
      ipPort: 4444,
      provider: 'TELECOMX',
      synced: '2016-01-01T00:00:00.000Z'
    },
    {
      ...
    }
  ]
}

Errors

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

WIKI

Table of Contents

API : Presence Proxy List

Introduction

Request

Query examples

Response

Example

Errors