Versions Compared

Old Version 13

changes.mady.by.user jtel Support

Saved on

compared with

New Version 14

changes.mady.by.user jtel Support

Saved on

Key

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

This API is called offline, after a call has ended in the JTEL ACD.

The result of the call, and some statistics regarding the call, are passed to the sales force instance.

This data can be used, for example, to create an activity record in SalesForce associated with the relevant SalesForce record.

To make use of this API, a REST endpoint must be provided in SalesForce for the jtel System to access.

Also, the following daemon must be activated in the jtel system:

\\acd-store\shared\JTELCarrierPortal\AppServer\SalesForce\SalesForce.Daemon.REST.writeCallStatistics.r5

The following pages describe an example implementation.

Request

POST

Data Structure

Data is passed to this API as a JSON structure. 

The following fields are provided:

Field NameDescription
SalesForceIDThe Id of the record in SalesForce.
jtelStatisticsPartAIDThe ID of the StatisticsPartA record in the jtel system.
AgentUID

The UID of the agent in the jtel system.

It is recommended, that for example the "NickName" field in SalesForce be used to map values between the systems, if the login UID cannot be made equal.

bOutbound0 = Inbound Call, 1 = Outbound Call.
CallerIDThe caller ID of the caller or called party, in E.164 format (fully qualified including country code) without a proceeding +.
ServiceNumberThe used service number in the jtel system, as configured in the "Service Number" field (database field ServiceNumbers.Name) in the jtel system.
ServiceNameThe used service in the jtel system, as configured in the "Name" field (database field ServiceNumbers.Name2) in the jtel system.
AcdAgentGroupsNameThe name of the agent group used in the jtel system.
AcdConfigurationGroupsNameThe name of the configuration group used in the jtel system. For standalone groups, this will be the same as the agent group name.
dtCallStartThe date and time of the start of the call in the format YYYY-MM-DDThh:mm:ss (local jtel server time).
dtCallAlertThe date and time of call ringing in the format YYYY-MM-DDThh:mm:ss (local jtel server time). This field can be empty, if no ringing occurs.
dtCallConnectThe date and time of call connect in the format YYYY-MM-DDThh:mm:ss (local jtel server time). This field can be empty, if no connect occurs.
dtCallEndThe date and time of call end in the format YYYY-MM-DDThh:mm:ss (local jtel server time). This field can be empty, if no ringing occurs.
nDurationDuration of the call in seconds. -1 means no connection. 0 can mean a very short connection (< 500 ms) indeed.
CONNRES

The result of the call

1 = Connection with agent
2 = No answer (Inbound = from agent, Outbound = from dialled number)
3 = Busy (Inbound = agent, Outbound = dialled number)
4 = Agent refused call during whisper announcement, or agent refused call during ringing
5 = ISDN cause (see Cause field for exact reason).
7 = Error

Cause

The Q.850 cause for the end of the call.

For example, 1 = invalid number, 16 = normal clearing, 17 = user busy.

TransactionCodeExportKeyIf a transaction code was recorded for the call, then this field will contain the export key of that transaction code.

http Status Codes

The following status codes should be used:

Status CodeMeaning

200 – OK

Data was written
409 – Conflict

Writing not possible due to a conflict in the data. Data should not be re-transmitted by the jtel system.

423 – LockedWriting not possible at this time. Data will be re-transmitted by the jtel system in this case.
404 - Not foundSales Force record not found. Data should not be re-transmitted by the jtel system.


Sv translation
languagede

Status
colourRed
titleThis page is only available in English

Sv translation
languagefr

Cette API est appelée hors ligne, après qu'un appel se soit terminé dans l'ACD JTEL.

Le résultat de l'appel, et certaines statistiques concernant l'appel, sont transmis à l'instance de la force de vente.

Ces données peuvent être utilisées, par exemple, pour créer un enregistrement d'activité dans SalesForce associé à l'enregistrement SalesForce concerné.

Pour utiliser cette API, un terminal REST doit être fourni dans SalesForce pour que le système jtel puisse y accéder.

De plus, le démon suivant doit être activé dans le système jtel :

\\acd-store\shared\JTELCarrierPortal\AppServer\SalesForce\SalesForce.Daemon.REST.writeCallStatistics.r5

Les pages suivantes décrivent un exemple de mise en œuvre.

Demande

POST

Structure des données

Les données sont transmises à cette API sous la forme d'une structure JSON. 

Les champs suivants sont prévus :

Nom du champDescription
SalesForceIDL'Id du dossier dans SalesForce.
jtelStatisticsPartAIDL'ID de l'enregistrement StatisticsPartA dans le système jtel.
AgentUID

L'UID de l'agent dans le système jtel.

Il est recommandé, par exemple, d'utiliser le champ "NickName" dans SalesForce pour faire correspondre les valeurs entre les systèmes, si l'UID de connexion ne peut être rendu égal.

bOutbound0 = appel entrant, 1 = appel sortant.
CallerIDL'identification de l'appelant ou de la partie appelée, au format E.164 (entièrement qualifié, y compris l'indicatif du pays) sans procédure +.
ServiceNumberLe numéro de service utilisé dans le système jtel, tel que configuré dans le champ "Service Number" (champ de la base de données ServiceNumbers.Name) dans le système jtel.
ServiceNameLe service utilisé dans le système jtel, tel que configuré dans le champ "Name" (champ de la base de données ServiceNumbers.Name2) dans le système jtel.
AcdAgentGroupsNameLe nom du groupe d'agents utilisé dans le système jtel.
AcdConfigurationGroupsNameLe nom du groupe de configuration utilisé dans le système jtel. Pour les groupes autonomes, ce sera le même que le nom du groupe d'agents.
dtCallStartLa date et l'heure du début de l'appel au format AAAA-MM-JJJh:mm:ss (heure locale du serveur jtel).
dtCallAlertLa date et l'heure de la sonnerie d'appel dans le format YYYY-MM-DDThh:mm:ss (heure locale du serveur jtel). Ce champ peut être vide, si aucune sonnerie ne se produit.
dtCallConnectLa date et l'heure de l'appel se connectent dans le format YYYY-MM-DDThh:mm:ss (heure locale du serveur jtel). Ce champ peut être vide, si aucune connexion ne se produit.
dtCallEndLa date et l'heure de la fin de l'appel dans le format YYYY-MM-DDThh:mm:ss (heure locale du serveur jtel). Ce champ peut être vide, si aucune sonnerie ne se produit.
nDurationDurée de l'appel en secondes. -1 signifie qu'il n'y a pas de connexion. 0 peut signifier une connexion très courte (< 500 ms) en effet.
CONNRES

Le résultat de l'appel

1 = lien avec l'agent
2 = Pas de réponse (Inbound = de l'agent, Outbound = du numéro composé)
3 = Occupé (Inbound = agent, Outbound = numéro composé)
4 = L'agent a refusé l'appel pendant l'annonce à voix basse, ou l'agent a refusé l'appel pendant la sonnerie
5 = cause ISDN (voir le champ Cause pour la raison exacte).
7 = Erreur

Cause

La cause de la fin de l'appel est le Q.850

Par exemple, 1 = numéro non valide, 16 = compensation normale, 17 = utilisateur occupé.

TransactionCodeExportKeySi un code de transaction a été enregistré pour l'appel, ce champ contiendra alors la clé d'exportation de ce code de transaction.

http Statut Codes

Les codes de statut suivants doivent être utilisés:

Statut CodeSignification

200 – OK

Les données ont été rédigées
409 – Conflict

Ecriture impossible en raison d'un conflit dans les données. Les données ne doivent pas être retransmises par le système jtel.

423 – LockedL'écriture n'est pas possible pour l'instant. Dans ce cas, les données seront retransmises par le système jtel.
404 - Not foundLe registre de la force de vente n'a pas été trouvé. Les données ne doivent pas être retransmises par le système jtel.