Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

The chat report export is a REST service that exports chat sessions from jtel to an external system.

The report export can be initiated manually by agents in the chat session, using the Report Export button:

Info

Notes: this requires the implementation of a REST service by the customer on the customer back-end system. The report export button will only appear, if the URL is configured in the Report Export Post parameters.

The configuration of the report export is performed in the Chat Connector configuration, on the REST tab.

Phase 1 - Token Post

Phase 1 is used to acquire an access token for the operation.

Info

Note: This is not necessary if a token is not required, and all necessary information can be provided in the second post request.


URL

This is the URL to which the post request to acquire the token should be sent.

Header

This part specifies the headers which should be sent with the request. Any necessary headers can be specified here.

Body

This part specifies the body which should be sent with the request. Any necessary body can be specified here.

Phase 2 - Report Export Post

The second phase posts the PDF report containing the chat session to the backend system.

Any data can be specified in the body. 


URL

This is the URL to which the report post should be sent.

Header

Specify any headers required here. The token retrieved in the first step can be specified, for example, with $tokenResponse.body.JSON.access_token

Body

Specify the body of the post request here. The XML template can be inserted into the body as base64 coded data using the variable $xmlTemplate.encoded.base64

Xml Template

This template can contain any data, which will be base 64 coded into the body when the variable $xmlTemplate.encoded.base64is used.

Variables

The following variables are provided, which can be used in either of the requests:

VariableMeaning
$ClientsIDThe ID of the client account.
$chatConnector.idThe ID of the chat connector.
$chatConnector.nameThe name of the chat connector.
$tokenResponse.body.JSON.access_tokenThe access token returned by the token post.
$report.encoded.base64The encoded PDF data as base 64 encoded data.
$report.bytesThe number of bytes in the encoded report PDF data.
$dateTimeThe current date and time in the format yyyy-MM-dd HH:mm:ss
$xmlTemplate.encoded.base64The XML template encoded in base 64 format.
$pdata.*

Where * is any variable from the pdata configured in the chat connector.

Example:

pdata: {name:'John Doe', email:'john.doe@example.com'}

$pdata.name will be equal to 'John Doe'.


Sv translation
languagefr

L'exportation de rapports de chat est un service REST qui exporte les sessions de chat de jtel vers un système externe.

L'exportation de rapport peut être lancée manuellement par les agents dans la session de chat, en utilisant le bouton d'exportation de rapport :

Info

Remarques : cela nécessite la mise en place d'un service REST par le client sur le système back-end du client. Le bouton d'exportation de rapport n'apparaîtra que si l'URL est configurée dans les paramètres d'exportation de rapport.

La configuration de l'exportation du rapport s'effectue dans la configuration du Chat Connector, dans l'onglet REST.

Phase 1 - Token Post

La phase 1 sert à acquérir un jeton d'accès pour l'opération.

Info

Note: Cela n'est pas nécessaire si un jeton n'est pas requis, et toutes les informations nécessaires peuvent être fournies dans la demande de deuxième courrier.


URL

Il s'agit de l'URL à laquelle la demande d'acquisition du jeton doit être envoyée par la poste.

Entête

Cette partie précise les en-têtes qui doivent être envoyés avec la demande. Tous les en-têtes nécessaires peuvent être spécifiés ici.

Corps

Cette partie précise l'organisme qui doit être envoyé avec la demande. Tout organe nécessaire peut être spécifié ici.

Phase 2 - Rapport sur les exportations

La deuxième phase consiste à envoyer le rapport PDF contenant la session de chat au système de gestion.

Toutes les données peuvent être spécifiées dans le corps. 


URL

Il s'agit de l'adresse URL à laquelle le rapport doit être envoyé.

Entête

Précisez ici les en-têtes nécessaires. Le jeton récupéré à la première étape peut être spécifié, par exemple, avec $tokenResponse.body.JSON.access_token

Corps

Précisez ici le corps de la demande de poste. Le modèle XML peut être inséré dans le corps en tant que données codées en base64 en utilisant la variable $xmlTemplate.encoded.base64

Template Xml

Ce modèle peut contenir n'importe quelle donnée, qui sera codée en base 64 dans le corps lorsque la variable $xmlTemplate.encoded.base64est utilisée

Variables

Les variables suivantes sont fournies, qui peuvent être utilisées dans l'une ou l'autre des demandes :

VariableSignification
$ClientsIDL'ID du Compte client.
$chatConnector.idL'ID du Connecteurs Chat.
$chatConnector.nameLe nom du connecteur Chat.
$tokenResponse.body.JSON.access_tokenLe jeton d'accès retourné par la poste.
$report.encoded.base64Les données PDF encodées en tant que données encodées en base 64.
$report.bytesLe nombre d'octets dans les données PDF encodées du rapport.
$dateTimeLa date et l'heure actuelles dans le format yyyy-MM-dd HH:mm:ss
$xmlTemplate.encoded.base64Le modèle XML encodé en format base 64.


...