Versions Compared

Old Version 7

changes.mady.by.user jtel Support

Saved on

compared with

New Version 8

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.
Sv translation
languageen

This API works in tandem with an IVR object in the Jtel system, which can be used to search for records in SAP when calls are received.

The results of the search performed are available as variables, and can be used to influence the routing in the Jtel system, for example to route to a particular agent, or to a particular ACD group.

To make use of this API, a REST endpoint must be provided in SAP for the Jtel System to access. The following pages describe an example implementation.

PS: The SAP IVR object should be added to the list of the allowed IVR objects By the Jtel system administrator.

Request

GET

Parameters

One of the following parameters is provided in the REST request:

Parameter NameDescription
Caller NumberThe caller number (caller ID). This parameter will be required if the function Caller Number was set. The number of the caller in E.164 format.
Customer IDThe customer ID (SAP customer ID). This parameter will be required if the function Customer ID was set.

http Status Codes

The following status codes should be used:

Status Code

Meaning

200 – OK

One record was found and returned.

200 – REST HTTP No Results Found

No records should be returned in this case.
REST HTTP Unknown Response CodeHTTP ERROR, unexpected HTTP response.

Return Structure

The return structure must be JSON, but otherwise any fields and any content can be returned. The Jtel System will parse the data into variables for the Jtel IVR GUI, of the form $SAP.FieldName

If structures are nested, then the variable will be named accordingly: $SAP.Entity.FieldName

Examining the call log will show you the exact field names returned.

Sv translation
languagefr

Cette API fonctionne en tandem avec un objet IVR dans le système Jtel, qui peut être utilisé pour rechercher des enregistrements dans SAP lorsque des appels sont reçus.

Les résultats de la recherche effectuée sont disponibles sous forme de variables, et peuvent être utilisés pour influencer le routage dans le système Jtel, par exemple pour acheminer vers un agent particulier, ou vers un groupe ACD particulier.

Pour utiliser cette API, un point terminal REST doit être fourni dans SAP pour que le système Jtel puisse y accéder. Les pages suivantes décrivent un exemple de mise en œuvre.

NB: L'objet SAP IVR doit être ajouté à la liste des objets IVR autorisés par l'administrateur système de Jtel.

Demande

GET

Paramètres

L'un des paramètres suivants est fourni dans la requête REST :

Nom du paramètreDescription
Numéro de l'appelantLe numéro de l'appelant (caller ID). Ce paramètre sera nécessaire si la fonction Numéro d'appel a été définie. Le numéro de l'appelant au format E.164.
ID ClientL'ID du client (SAP customer ID). Ce paramètre sera nécessaire si la fonction ID client a été définie.

codes de statut http

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

Statut Code

Signification

200 – OK

Un enregistrement a été trouvé et retourné.

200 - REST HTTP Aucun résultat trouvé

Aucun dossier ne doit être retourné dans ce cas.
REST HTTP Code de réponse inconnuERREUR HTTP, réponse HTTP inattendue.

Structure de retour

La structure de retour doit être JSON, mais sinon tous les champs et tout le contenu peuvent être retournés. Le système Jtel analysera les données en variables pour l'interface graphique IVR de Jtel, de la forme $SAP.FieldName

Si les structures sont imbriquées, la variable sera nommée en conséquence : $SAP.Entity.FieldName

L'examen du journal des appels vous indiquera les noms exacts des champs retournés.