Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languagefr

Table of Contents
maxLevel1

Récupérer tous les AcdEvents

Cette fonction récupère tous les AcdEvents du compte client.

URL

Translations Ignore


Code Block
GET {baseURL}/acd/events


Paramètres

Aucun

Réponses

Si 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 :

ChampTypeDonnées
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsAcdEvent []Un tableau d'AcdEvents.
compterEntierLe nombre d'enregistrements retournés.
orderByChaîne de caractèresLe champ utilisé pour trier les enregistrements. 
ascendantBooléenSi l'ensemble des enregistrements est trié de manière ascendante ou descendante.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "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 ID

Cette 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

Type

Données

AcdEventsIDURLEntierL'ID de l'AcdEvent.

Réponses

Si 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 :

ChampTypeDonnées
enregistrementsAcdEvent []Un ensemble d'AcdEvents contenant un AcdEvent.
compterEntier1
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

Translations Ignore


Code Block
languagejs
{ "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

Translations Ignore


Code Block
POST {baseURL}/acd/events/create


Paramètres

Aucun.

Après Données

Une structure JSON contenant les paramètres suivants :

Paramètre

RequiseSoutenu dans les AcdEventTypes

Type

Données

AcdEventTypesIDOui
EntierL'ID de l'AcdEventType à créer.
AcdGroupsIDOuiTousEntierL'ID de l'AcdGroup auquel cet événement doit être distribué.
UsersIDNonTousEntierL'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éditeurOuiTousChaî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écepteurNonTousChaî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.

SujetOuiTousChaîne de caractèresUne chaîne de caractères à associer à l'événement. Peut être n'importe quel texte.
CorpsNonRappelChaîne de caractèresUn corps qui sera ajouté aux données du corps de l'événement.
CrmURLNonTousChaîne de caractèresUne URL qui sera associée à l'événement. Cela doit correspondre à une URL bien formée.
UserDataNonTousChaî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

Status
colourBlue
titleFROM RELEASE 3.35

NonTousEntier

La priorité de l'événement. Si elle n'est pas spécifiée, la priorité est de 50.

dtAppointmentDate

Status
colourBlue
titleFROM RELEASE 3.35

NonTousChaî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 :

  • Si les deux sont vides ou non renseignés, aucun rendez-vous n'est fixé. L'événement sera distribué dès que possible.
  • Si seule une date est fournie, l'heure est fixée à 00:00. L'événement sera distribué au plus tôt à la date spécifiée ; la distribution sera tentée immédiatement si cette date est passée.
  • Si seule une heure est fournie, la date sera fixée à la prochaine occurrence possible de cette heure. Exemple :
    • S'il est actuellement 15:30 et que l'heure est fixée à 10:00, la date sera fixée au jour suivant.
    • S'il est actuellement 15:30 et que l'heure est fixée à 18:00, la date sera fixée au même jour.
  • Si une date et une heure sont fournies, le rendez-vous est fixé exactement à cette date. L'événement sera distribué au plus tôt à la date spécifiée ; la distribution sera tentée immédiatement si la date est passée.

Remarque : la distribution réelle dépend des agents connectés et des exigences de distribution (compétence, priorité, etc.).

dtAppointmentTime

Status
colourBlue
titleFROM RELEASE 3.35

NonTousChaî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.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

ChampTypeDonnées
enregistrementsAcdEvent []Un tableau d'AcdEvents contenant l'AcdEvent créé.
compterEntier1
statutEntierLe 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


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
languagejs
{ "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 }