api:tools:realtime:proxy
Table of Contents
API : Tools: Realtime proxy
Introduction
This request is used internally by Telecom X servers to request the broadcast of a realtime config event to subscribing listeners.
Request
| URL | https://api.telecomx.dk/tools/realtime | ||
|---|---|---|---|
| Method | GET, POST | ||
| Access level | Only Telecom X servers | ||
| Param | eventType | String | Type of event. Only registered events may be used. |
| customer | Id | Id of customer the event happened on. | |
| id | Id | Id of item the event happened on. | |
| data | Object | [optional] Optional data related to the event (only when using POST). |
|
| employee | Id | [optional] Optional id of employee who caused the event. |
|
Query example - GET
https://api.telecomx.dk/tools/realtime?eventType=EMPLOYEE_PRESENCE_CHANGED&customer=12345678901234567890ABCD&id=1234567890123457890AAAA
Query example - POST
{ eventType: 'EMPLOYEE_PRESENCE_CHANGED', customer: '12345678901234567890ABCD', employee: '12345678901234567890DDDD', id: '12345678901234567890AAAA', data: { something: true, extra: 'bla bla bla' } }
Response
| Field | Type | Description |
|---|---|---|
| success | Boolean | True on success. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/tools/realtime/proxy.txt · Last modified: 2023/05/17 08:29 by Per Møller