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 decide whether the call can proceed, and what calling party number should be used when the call is made.

For example, calling a customer might require that the hotline telephone number is transmitted, whilst calling a supplier might require that the extension number of the agent be used. 

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.

Request

GET

Parameters

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

The following parameters are provided:

Field NameDescription
Authorization TokenThe Basic Authentication Token which is the encoded Base 64 of username:password
REST ParametersThese parameters are separated by Carriage return. All variable starts with the dollar sign '$' e.g.
 $filter=CustomerID eq '$SAPBusinessPartnerID'
 $expand=IndividualCustomerSalesData

http Status Codes

The following status codes should be used:

Status CodeMeaning

200 – OK

OK, dialling may proceed using the supplied information.

200 – REST HTTP No Results FoundBad input parameter, for example SAP record not found.

403 – Forbidden

Bad credential and Call is not allowed. 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. The following fields should be supplied:

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 by concatinating the distributionChannelCodeText and countryCode . 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 décider si l'appel peut être effectué, et quel numéro de l'appelant doit être utilisé lors de l'appel.

Par exemple, appeler un client peut nécessiter la transmission du numéro de téléphone de la hotline, tandis qu'appeler un fournisseur peut nécessiter l'utilisation du numéro de poste de l'agent. 

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.

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
Jeton d'autorisationLe jeton d'authentification de base qui est la base 64 codée du nom d'utilisateur:mot de passe
Paramètres REST Ces paramètres sont séparés par le retour chariot. Toutes les variables commencent par le signe dollar '$' e.g.
 $filter=CustomerID eq '$SAPBusinessPartnerID'
 $expand=IndividualCustomerSalesData

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.

200 - REST HTTP Aucun résultat trouvéParamètre d'entrée incorrect, par exemple enregistrement SAP introuvable.

403 – Forbidden

Mauvais identifiant et l'appel n'est pas autorisé. 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. Les champs suivants doivent être fournis :

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. Le ServiceNumber trouvé sera utilisé pour signaler l'appel sortant.