Versions Compared

Old Version 10

changes.mady.by.user jtel Support

Saved on

compared with

New Version 11

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 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 jtel System to access. The following pages describe 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
SAPBusinessPartnerIDThe Id ID of the record in SAP which should be called (the one the user clicked on).
SAPPhoneNumberThe number to be called (the number clicked on in SAP, cleaned to remove unnecessary characters, punctuation and characters which cannot be dialled).

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. The It should be possible to extract the following fields should be suppliedfrom 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.

...