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 Name | Description |
|---|---|
| Authorization Token | The Basic Authentication Token which is the encoded Base 64 of username:password |
| REST Parameters | These 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 Code | Meaning |
|---|---|
200 – OK | OK, dialling may proceed using the supplied information. |
| 200 – REST HTTP No Results Found | Bad 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 Name | Description |
|---|---|
distributionChannelCodeText | This parameter will be parsed from the JSON Result path and will be used to match a service number. |
| countryCode | This 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.