API : Tools: Realtime : Clients : List

Introduction

This request will return a list of realtime clients currently connected.

Request

URL	https://api.telecomx.dk/tools/realtime/client
Method	GET
Access level	Viewer, Manager, Reseller, ResellerAdmin and Admin
Query	offset	Number	`[optional]` Index of first item to return. Default 0.
	limit	Number	`[optional]` Max number of items to return, 1-500. Default 50.
	customer	Id	`[optional]` Id of customer client must belong to.
	employee	Id	`[optional]` Id of employee client must belong to.
	expand	Boolean	`[optional]` True to add customer and employee names.
	filter	String	`[optional]` Search filter, searches ip, clientApp and server.

Query example

https://api.telecomx.dk/tools/realtime/client
https://api.telecomx.dk/tools/realtime/client?offset=100&limit=100
https://api.telecomx.dk/tools/realtime/client?customer=12345789012457890ABCD
https://api.telecomx.dk/tools/realtime/client?employee=1234567890123456780AAAA
https://api.telecomx.dk/tools/realtime/client?expand=true

Response

Field	Type	Description
offset	Number	Offset of first entry returned - 0-100000.
limit	Number	Max. number of entries to return - 1-1000.
total	Number	Number of entries when offset/limit is not considered.
clients	Array	List of clients.
clients[]._id	String	Client id.
clients[].employee	Id	Id of employee.
clients[].employeeName	String	Name of employee, if expand is true.
clients[].customer	Id	Id of customer.
clients[].customerName	String	Name of customer, if expand is true.
clients[].accessLevel	String	Employees access level, see here for description of levels.
clients[].connected	Date	When the client was connected.
clients[].ip	String	Remote IP address.
clients[].clientApp	String	Name of client application.
clients[].server	String	Name of server client is connected to.
clients[].instanceId	String	Id of the device/client that is persistent across sessions.

Example

{
  offset: 0,
  limit: 100,
  total: 200,
  clients: [
    {
      "_id": "438943y89ehuo2fhuidhuhudv",
      "employee": "12345678901234567890AAAA",
      "employeeName": "Donald Duck",
      "customer": "12345678901234567890BBBN",
      "customerName": "Didsney Corp",
      "accessLevel": "PERSONAL",
      "connected": "2021-01-01T00:00:00.000Z",
      "ip": "1.2.3.4",
      "clientApp": "Communicator",
      "server": "web1.telecomx.dk:80",
      "instanceId": "ftwf73i6idjet3hdyr6457eyrhd64h43"
    },
    {
      ...
    }
  ]
}

Errors

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

WIKI

Table of Contents

API : Tools: Realtime : Clients : List

Introduction

Request

Query example

Response

Example

Errors