Versions Compared

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 is called when a click to dial is requested by agents using SAP.

The API can be used to decide whether the call can proceed, and what

...

service number should be used when the call is made

...

.

...

To make use of this API, a REST endpoint must be provided in SAP for the

...

jtel System to access. The following

...

CallerID

describes an example implementation.

Request

GET

Parameters

Data is passed to this API as parameters in the GET request.

The following parameters are provided:

Field NameDescription

...

REST Parameters

...

SAPBusinessPartnerIDThe ID of the record in SAP which should be called (the one the user clicked on).
SAPPhoneNumber
The number to be called (the number clicked on in

...

SAP, cleaned to remove unnecessary characters, punctuation and characters which cannot be dialled)

...

.

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.

http Status Codes

The following status codes should be used:

Status CodeMeaning

200 – OK

OK, dialling may proceed using the supplied information.

...

400 - Bad Request

Bad input parameter, for example SAP record not found. The jtel system will refuse to place the call if this code is returned.

403 – Forbidden

...

Call is not allowed. The jtel system will refuse to place the call if this code is returned.
404 - Not foundSAP record not found. The

...

jtel system will refuse to place the call if this code is returned.

Return Data

Data should be returned from this request in JSON format.

...

It should be possible to extract the following fields

...

from the result:

Field NameDescription

distributionChannelCodeText

This parameter will be parsed from the JSON Result path and will be used to match a service number. 
countryCodeThis parameter will be parsed from the JSON Result path and will be used to match a service number.

The

...

jtel system will attempt to match a ServiceNumber based on the Contract Number, which must be set by

...

concatenating the distributionChannelCodeText and countryCode in jtel service number configuration. The found ServiceNumber will be used for signalling the outbound call.

Sv translation
languagefr

Cette API est appelée lorsqu'un clic de numérotation est demandé par les agents utilisant SAP.

L'API peut être utilisée pour décider si l'appel peut être poursuivi et quel numéro de service doit être utilisé lors de l'appel.

Pour utiliser cette API, un point de terminaison REST doit être fourni dans SAP pour que le système jtel puisse y accéder. Ce qui suit décrit un exemple d'implémentation.

Demande

GET

Paramètres

Les données sont transmises à cette API en tant que paramètres dans la requête GET.

Les paramètres suivants sont fournis :

Nom de domaineDescription
SAPBusinessPartnerIDL'ID de l'enregistrement dans SAP qui doit être appelé (celui sur lequel l'utilisateur a cliqué).
SAPPhoneNumberLe numéro à appeler (le numéro sur lequel vous avez cliqué dans SAP, nettoyé pour supprimer les caractères inutiles, la ponctuation et les caractères qui ne peuvent pas être composés).

codes de statut http

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

Statut CodeSignification

200 – OK

OK, la composition peut se poursuivre en utilisant les informations fournies.

400 - Bad Request

Paramètre d'entrée incorrect, par exemple enregistrement SAP introuvable. Le système jtel refusera de passer l'appel si ce code est renvoyé.

403 – Forbidden

Les appels ne sont pas autorisés. Le système jtel refusera de passer l'appel si ce code est renvoyé.
404 - Not foundEnregistrement SAP introuvable. Le système jtel refusera de passer l'appel si ce code est renvoyé.

Retour des données

Les données doivent être renvoyées à partir de cette demande au format JSON. Il devrait être possible d'extraire les champs suivants du résultat:

Nom du champDescription

distributionChannelCodeText

Ce paramètre sera analysé à partir du chemin du résultat JSON et sera utilisé pour correspondre à un numéro de service.
countryCodeCe paramètre sera analysé à partir du chemin du résultat JSON et sera utilisé pour correspondre à un numéro de service.

Le système jtel tentera de faire correspondre un numéro de service basé sur le numéro de contrat, en concaténant la distribution ChannelCodeText et countryCode dans la configuration du numéro de service jtel. Le ServiceNumber trouvé sera utilisé pour signaler l'appel sortant.

Sv translation
languagede

Status
colourRed
titleThis page is only available in English