FROM RELEASE 3.34
This API works in tandem with a workflow object in the jtel IVR / workflow designer, and can be used to query the Salesforce system for almost any kind of data, or update records in the Salesforce system to reflect changes in the jtel system.
Examples of use cases:
- Tasks which need to be assigned to agents.
- Cases which need to be assigned to agents.
- Updating the status of tasks or cases to reflect that they are "in" the jtel system being processed.
- And much more ...
Request
POST to custom endpoint (provided as a parameter to the workflow object in the jtel workflow designer).
Parameters
The following parameters are provided in the REST request:
| Parameter Name | Description |
|---|---|
| Param1 | A string parameter (can contain any data as required by the use-case). |
| Param2 | A string parameter (can contain any data as required by the use-case). |
| Param3 | A string parameter (can contain any data as required by the use-case). |
| Param4 | A string parameter (can contain any data as required by the use-case). |
| Query | A string parameter (can contain any data as required by the use-case). |
Note:
- The actual use of the parameters will depend on the use-case being implemented.
http Status Codes
The following status codes should be used:
| Status Code | Meaning |
|---|---|
| 200 - OK | One record was found or processed. |
| 300 - Multiple Choices | Multiple records were found or processed. |
| 404 - Not Found | No records were found or processed. |
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 workflow GUI, of the form $SalesForce.FieldName
If structures are nested, then the variable will be named accordingly: $SalesForce.Entity.FieldName
Examining the call log will show you the exact field names returned.