Récupérer tous les AcdEventsCette fonction récupère tous les AcdEvents du compte client. URL| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/acd/events |
|
ParamètresAucun RéponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants : | Champ | Type | Données |
|---|
| filtre | Chaîne de caractères | Le filtre appliqué. Il est réservé à un usage futur. | | limitStart | Entier | Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation future. | | limitPageSize | Entier | Le nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future. | | enregistrements | AcdEvent [] | Un tableau d'AcdEvents. | | compter | Entier | Le nombre d'enregistrements retournés. | | orderBy | Chaîne de caractères | Le champ utilisé pour trier les enregistrements. | | ascendant | Booléen | Si l'ensemble des enregistrements est trié de manière ascendante ou descendante. | | statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple| Translations Ignore |
|---|
| Code Block |
|---|
| { "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "SkillsValue2": null, "SkillsValue1": null, "ChatConnectorsID": 1, "UserData": "123456", ... "AcdEventStatusID": 20, "dtLastModified": "2020-08-09T02:33:50.347" } ], "count": 374, "orderBy": "dtCreated", "ascending": true, "status": 200 } |
|
Récupérer un AcdEvent par IDCette fonction récupère un AcdEvent par ID du compte client. URL| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/acd/events/event/{AcdEventsID} |
|
Paramètres Paramètre | Où | Type | Données |
|---|
| AcdEventsID | URL | Entier | L'ID de l'AcdEvent. |
RéponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants : | Champ | Type | Données |
|---|
| enregistrements | 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| Translations Ignore |
|---|
| 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 AcdEventCette fonction crée un AcdEvent. URL| Translations Ignore |
|---|
| Code Block |
|---|
POST {baseURL}/acd/events/create |
|
ParamètresAucun. Après DonnéesUne structure JSON contenant les paramètres suivants : ParamètreParamètre | Requise | Soutenu dans les AcdEventTypes | Type | Données |
|---|
| AcdEventTypesID | Oui |
| 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. |
RéponsesIf the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles. 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éesCréer un événement de rappel : | 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" } |
|
Créer un événement de rappel pour un utilisateur spécifique : | Translations Ignore |
|---|
| 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" } |
|
Créer un événement de ticket: | 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" } |
|
Exemple de réponse : | Translations Ignore |
|---|
| Code Block |
|---|
| { "records": [ { "SkillsValue2": null, "SkillsValue1": null, "ChatConnectorsID": null, "UserData": "123456", "SkillsValue3": null, "dtReceived": null, "AcdGroupsID": 235, "dtRemind": null, "EventData": "<eventData><urls><url><urlPath>https://www.jtel.de</urlPath><displayName>123456</displayName></url></urls><body html=\"true\"></body></eventData>", "AcdWorkFlowConnectorsID": null, "AcdInboxesID": null, "ID": 2039, "LastAgentTime": 0, "CrmURL": "https://www.jtel.de", "WorkFlowMonitorPointsID": null, "AcdReplyingTypesID": null, "AcdEventTypesID": 6, "dtModified": "2020-09-15T02:59:32.794", "bCloseByForeignSystem": false, "Receiver": "support@jtel.de", "Subject": "A new ticket 123456 has been created via the REST API. Congratulations!", "UsersID": null, "Sender": "info@example.com", "ForeignSystemNumber": "123456", "dtCreated": "2020-09-15T02:59:32.794", "UserData2": null, "UserData3": null, "SkillsID3": null, "SkillsID1": null, "SkillsID2": null, "AcdEventStatusID": 1, "dtLastModified": "2020-09-15T02:59:32.929" } ], "count": 1, "status": 200 } |
|
|
