Versions Compared

Old Version 13

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

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 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 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 jtel System to access. The following pages describe describes an example implementation.

P.S. Note: The SAP IVR object should be added to the list of the allowed IVR objects By by the Jtel jtel system administrator.

See also: IVR Object - SAP getCallerInformation

Request

GET

Parameters

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

Parameter NameDescription
FunctionChoose either Caller Number or Customer ID.
Caller NumberThis parameter will be required if the function Caller Number was set. The number of the caller in E.164 (fully qualified without +) 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 are the possible status codes:

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 ERRORUnknown HTTP response or REST error.

Return Structure

The return structure must be JSON, but otherwise any fields and any content can be returned. The Jtel jtel System will parse the data into variables for the Jtel 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 Jteljtel, 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 Jteljtel, par exemple pour acheminer router vers un agent particulier, ou vers un groupe ACD particulier.

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

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

Voir aussi: IVR Object - SAP getCallerInformation.

Demande

GET

Paramètres

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

Nom du paramètreDescription
FonctionChoisissez le numéro Numéro de l'appelant ou le numéro du client.
Numéro Le numéro de l'appelant (caller ID). Ce paramètre sera nécessaire requis si la fonction Numéro dde l'appel appelant a été définie. Le numéro de l'appelant au dans le format E.164 (pleinement qualifié sans +).
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 Voici les codes de statut suivants doivent être utilisésstatus possibles:

Statut Code de statut

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 inconnuERRORRéponse HTTP inconnue ou erreur RESTERREUR 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 jtel analysera les données en variables pour l'interface graphique jtel 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.

Sv translation
languagede

Status
colourRed
titleThis page is only available in English