This function retrieves all AcdEvents from the client account.
|
None
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 |
---|---|---|
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 [] | An array of AcdEvents. |
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). |
|
This function retrieves one AcdEvent by ID from the client account.
|
Parameter | Where | Type | Data |
---|---|---|---|
AcdEventsID | URL | Integer | The ID of the AcdEvent. |
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 one AcdEvent. |
count | Integer | 1 |
status | Integer | The return code (also provided by the http status code). |
|
This function creates an AcdEvent.
|
None.
A JSON structure containing the following parameters:
Parameter | Required | Supported in AcdEventTypes | Type | Data |
---|---|---|---|---|
AcdEventTypesID | Yes | Integer | The ID of the AcdEventType to create. | |
AcdGroupsID | EITHER THIS | All | Integer | The ID of the AcdGroup to which this event should be distributed. Either specify this, or the parameters AcdConfigurationGroupsID and AcdAgentGroupsID. |
AcdConfigurationGroupsID | OR BOTH OF THESE | All | Integer | The ID of the Configuration Group to which this event should be distributed. Either specify this with AcdAgentGroupsID, or specify AcdGroupsID. |
AcdAgentGroupsID | OR BOTH OF THESE | All | Integer | The ID of the Agent Group to which this event should be distributed. Either specify this with AcdAgentGroupsID, or specify AcdGroupsID. |
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. |
nPriority | No | All | Integer | The priority of the event. If not specified, 50 is used. |
dtAppointmentDate | No | All | String | The date part of the required appointment in the format yyyy-mm-dd or yyyymmdd The fields dtAppointmentDate and dtAppointmentTime are set as follows:
Note: actual distribution depends on the agents logged in and the distribution requirements (skill, priority etc.). |
dtAppointmentTime | No | All | String | The time part of the required appointment in the format hh:mm or hhmm See dtAppointmentDate above for important details on how to use this parameter. |
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. |
count | Integer | 1 |
status | Integer | The return code (also provided by the http status code). |
Create a callback event:
|
Create a callback event for a specific user:
|
Create a ticket event:
|
Example response:
|
NOTE: If the Result_ parameter is received in the returned event and this contains the value "UPDATED", then this means the ACD group configuration stipulates that no duplicate ACD events should be created. In this case, the existing event is returned and updated with a comment. |