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). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Translations Ignore |
Code Block |
---|
{
"AcdEventTypesID": 3,
"AcdGroupsID": 235,
"UsersID": null,
"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 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:
| 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 | |||||
---|---|---|---|---|---|
|
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:
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
|
Sv translation | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Récupérer un AcdEvent par ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Cette fonction récupère tous les AcdEvents un AcdEvent par ID du compte client. URL
ParamètresAucun RéponsesIf the request is performed, 200 OK is returned. See Return Codes for further possible status codes. Données retournées (200 OK)Une structure JSON contenant les champs 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
Créer un AcdEventpar IDCette fonction récupère un AcdEvent par ID du compte clientcrée un AcdEvent. URL
ParamètresParamètre Où Type Données | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcdEventsID | URL | Entier | L'ID de l'AcdEvent. |
Paramètre | Requise | Soutenu dans les AcdEventTypes | |
---|---|---|---|
Type | Données | ||
AcdEventTypesID | enregistrementsOui | AcdEvent [] | Un ensemble d'AcdEvents contenant un AcdEvent. |
compter | Entier | 1 | |
statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple
Code Block | ||
---|---|---|
| ||
{ "records": [ { "SkillsValue2": null, "SkillsValue1": null, "ChatConnectorsID": 1, "UserData": "123456", ... "AcdEventStatusID": 20, "dtLastModified": "2020-08-09T02:33:50.347" } ], "count": 1, "status": 200 } |
Créer un AcdEvent
Cette fonction crée un AcdEvent.
URL
Code Block |
---|
POST {baseURL}/acd/events/create |
Paramètres
Aucun.
Après Données
Une structure JSON contenant les paramètres suivants :
Paramètre
Type
Données
Une chaîne de caractères identifiant l'expéditeur.
Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone au format E.164 (messagerie vocale et demandes de rappel).
Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse électronique.
Une chaîne de caractères identifiant le récepteur.
Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone qui est disponible dans le système en tant que numéro de service configuré au format E.164 (messagerie vocale et demandes de rappel).
Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse email.
Un champ de données utilisateur facultatif qui sera associé à l'événement.
Pour les événements avec billets (Workflow), cela correspondra au numéro de billet du système étranger.
Entier | L'ID de l'AcdEventType à créer. | |||||||||
AcdGroupsID | Oui | Tous | Entier | L'ID de l'AcdGroup auquel cet événement doit être distribué. | ||||||
UsersID | Non | Tous | Entier | L'ID de l'utilisateur auquel cet événement doit être distribué. S'il n'est pas fourni, l'événement est distribué via la file d'attente de groupe. | ||||||
Expéditeur | Oui | Tous | Chaîne de caractères | Une chaîne de caractères identifiant l'expéditeur. Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone au format E.164 (messagerie vocale et demandes de rappel). Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse électronique. | ||||||
Récepteur | Non | Tous | Chaîne de caractères | Une chaîne de caractères identifiant le récepteur. Pour les événements liés au téléphone, il doit s'agir d'un numéro de téléphone qui est disponible dans le système en tant que numéro de service configuré au format E.164 (messagerie vocale et demandes de rappel). Pour d'autres événements, les données peuvent être spécifiques au contexte - par exemple une adresse email. | ||||||
Sujet | Oui | Tous | Chaîne de caractères | Une chaîne de caractères à associer à l'événement. Peut être n'importe quel texte. | ||||||
Corps | Non | Rappel | Chaîne de caractères | Un corps qui sera ajouté aux données du corps de l'événement. | ||||||
CrmURL | Non | Tous | Chaîne de caractères | Une URL qui sera associée à l'événement. Cela doit correspondre à une URL bien formée. | ||||||
UserData | Non | Tous | Chaîne de caractères | Un champ de données utilisateur facultatif qui sera associé à l'événement. Pour les événements avec billets (Workflow), cela correspondra au numéro de billet du système étranger. | ||||||
nPriority
| Non | Tous | Entier | La priorité de l'événement. Si elle n'est pas spécifiée, la priorité est de 50. | ||||||
dtAppointmentDate
| Non | Tous | Chaîne de caractères | La date du rendez-vous requis au format yyyy-mm-dd ou yyyy-mm-dd. Les champs dtAppointmentDate et dtAppointmentTime sont définis comme suit :
Remarque : la distribution réelle dépend des agents connectés et des exigences de distribution (compétence, priorité, etc.). | ||||||
dtAppointmentTime
| Non | Tous | Chaîne de caractères | La partie temporelle du rendez-vous requis au format hh:mm ou hhmm Voir dtAppointmentDate ci-dessus pour des détails importants sur l'utilisation de ce paramètre. |
Réponses
Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles
Réponses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Données retournées (200 OK)
Une structure JSON contenant les champs suivants :
Champ | Type | Données |
---|---|---|
enregistrements | AcdEvent [] | Un tableau d'AcdEvents contenant l'AcdEvent créé. |
compter | Entier | 1 |
statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple Après-données
Créer un événement de rappel :
Translations Ignore | ||
---|---|---|
|
Créer un événement de rappel pour un utilisateur spécifique :
Translations Ignore | ||
---|---|---|
|
Créer un événement de ticket:
Translations Ignore | ||
---|---|---|
|
Exemple de réponse :
Translations Ignore | |||||
---|---|---|---|---|---|
|