...
Field | Type | Data |
---|---|---|
filter | String | The applied filter. This is reserved for future use. |
limitStart | Integer | The first record index. Currently 0, reserved for future use. |
limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
records | AcdEvent CockpitVariable [] | An array of Cockpit Variables. |
count | Integer | The number of records returned. |
orderBy | String | The field used to sort the records. |
ascending | Boolean | Whether the array of records is sorted ascending or descending. |
status | Integer | The return code (also provided by the http status code). |
...
A JSON Structure containing the following fields:
Field | Type | Data |
---|---|---|
records | AcdEvent CockpitVariable [] | An array of CockpitVariables containing one CockpitVariable. |
count | Integer | 1 |
status | Integer | The return code (also provided by the http status code). |
...
Translations Ignore | ||
---|---|---|
|
Parameters
None.
...
A JSON structure containing the following parameters:
Parameter | Required | Supported in AcdEventTypesWhere | Type | Data |
---|---|---|---|---|
AcdEventTypesIDvalue | YesURL | Integer | The ID of the AcdEventType to create. | |
AcdGroupsID | Yes | All | Integer | The ID of the AcdGroup to which this event should be distributed. |
UsersID | No | All | Integer | The ID of the User to which this event should be distributed. If not provided, the event is distributed via the group queue. |
Sender | Yes | All | String | A string identifying the sender. For telephone related events this should be a telephone number in E.164 format (Voice Mail and Callback Requests). For other events the data may be context specific - for example an email address. |
Receiver | No | All | String | A string identifying the receiver. For telephone related events this should be a telephone number which is available in the system as a configured service number in E.164 format (Voice Mail and Callback Requests). For other events, the data may be context specific - for example an email address. |
Subject | Yes | All | String | A string subject to associate with the event. Can be any text. |
Body | No | Callback | String | A body which will be added to the event body data. |
CrmURL | No | All | String | An URL which will be associated with the event. This should correspond to a well formed URL. |
UserData | No | All | String | An optional user data field which will be associated with the event. For Ticket (Workflow) events, this will correspond to the foreign system ticket number. |
Responses
value to set. |
Responses
If the request is performed, 200 OK is returned. The result value should be checked, to see the actual result of the operation. See also If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
...
A JSON Structure containing the following fields:
Field | Type | Data | |||
---|---|---|---|---|---|
records | AcdEvent [] | An array of AcdEvents containing the created AcdEvent. | |||
result | Integer | 0 = Operation was OK 1 = Variable is not writable 2 = Variable not found or not visible for cockpit 3 = value was not changed (same value) 4 = value was not changed (min / max values would be exceeded) | |||
error | String | A string representation of the error, | count | Integer | 1 |
status | Integer | The return code (also provided by the http status code). |
Example Post Data
Create a callback event:
...
. |
...
Create a callback event for a specific user:
...
Code Block |
---|
{
"AcdEventTypesID": 3,
"AcdGroupsID": 235,
"UsersID": 3,
"Sender" : "49199123456789",
"Receiver" : "4919900112233",
"Subject": "Callback request from 49199123456789 on 2020.08.09 at 09:00",
"Body": "This is an automatically generated callback request via the REST API.\r\nCongratulations!\r\n",
"CrmURL": "https://www.jtel.de",
"UserData": "987654"
} |
Create a ticket event:
...
Code Block |
---|
{
"AcdEventTypesID": 6,
"AcdGroupsID": 235,
"UsersID": null,
"Sender" : "info@example.com",
"Receiver" : "support@jtel.de",
"Subject": "A new ticket 123456 has been created via the REST API. Congratulations!",
"CrmURL": "https://www.jtel.de",
"UserData": "123456"
} |
Example response:
...
language | js |
---|
...