This API works in tandem with an IVR object in the 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 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 System to access. The following pages describe an example implementation.
PS: The SAP IVR object should be added to the list of the allowed IVR objects By the Jtel system administrator.
Request
GET
Parameters
One of the following parameters is provided in the REST request:
| Parameter Name | Description |
|---|---|
| Caller Number | The caller number (caller ID). This parameter will be required if the function Caller Number was set. The number of the caller in E.164 format. |
| Customer ID | The customer ID (SAP customer ID). This parameter will be required if the function Customer ID was set. |
http Status Codes
The following status codes should be used:
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 Unknown Response Code | HTTP ERROR, unexpected HTTP response. |
Return Structure
The return structure must be JSON, but otherwise any fields and any content can be returned. The Jtel System will parse the data into variables for the 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.