Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieve all AcdEventsThis function retrieves all AcdEvents from the client account. URL
ParametersNone ResponsesIf the request is performed, 200 OK is returned. See Return Codes for further possible status codes. Returned Data (200 OK)A JSON Structure containing the following fields:
Example
Retrieve an AcdEvent by IDThis function retrieves one AcdEvent by ID from the client account. URL
Parameters
ResponsesIf the request is performed, 200 OK is returned. See Return Codes for further possible status codes. Returned Data (200 OK)A JSON Structure containing the following fields:
Example
Create an AcdEventThis function creates an AcdEvent. URL
ParametersNone. Post DataA JSON structure containing the following parameters:
ResponsesIf the request is performed, 200 OK is returned. See Return Codes for further possible status codes. Returned Data (200 OK)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). |
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. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
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). |
Example Post Data
Create a callback event:
Translations Ignore | ||
---|---|---|
|
Create a callback event for a specific user:
Translations Ignore | ||
---|---|---|
|
Create a ticket event:
Translations Ignore | ||
---|---|---|
|
Example response:
Translations Ignore | |||||
---|---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
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. |
Sv translation | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Récupérer tous les AcdEventsCette fonction récupère tous les AcdEvents du compte client. URL
ParamètresAucun RéponsesSi la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants :
Exemple
Récupérer un AcdEvent par IDCette fonction récupère un AcdEvent par ID du compte client. URL
Paramètres
RéponsesSi la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants :
Exemple
Créer un AcdEventCette fonction crée un AcdEvent. URL
ParamètresAucun. Après DonnéesUne structure JSON contenant les paramètres suivants :
RéponsesSi la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants :
Exemple Après-donnéesCréer un événement de rappel Example Post DataCreate a callback event :
Créer un événement de rappel pour un utilisateur spécifique Create a callback event for a specific user :
Create a ticket eventCréer un événement de ticket:
Example responseExemple de réponse :
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
colour | Red | title | This page is only available in English
|