Introduction
The REST API for the dialler supports the following functions:
- Dialler campaigns
- Retrieval
- Cloning
- Dialler campaign result codes
- Retrieval
- Dialler Contacts
- Retrieval
- Importing
- Locking and Unlocking
- Deleting
Workflow
The CRM / ERP or other backend system provides dialler contacts to the jtel System when a dialler campaign should be executed.
It is very important to plan workflow for the dialler correctly, so that contacts are only removed from the jtel system when the necessary statistics have been retrieved from the jtel system and the contact is in the required state for removal.
API Access and Authorization
The API is accessed using the base URL of the API Server and the following URL:
http(s)://jtel-rest-api-server:port/rest/v1.0/{ClientsID}
The ClientsID must be provided with every request.
The Authorisation is Bearer authorization, using one of the tokens generated in the jtel portal. To perform bearer authorization, provide the following http header:
Authorization: Bearer {TOKEN}
The tokens are generated here:
Generating a new token or removing the token will immediately invalidate the token.
Functions
Retrieve all Dialler Campaigns
http://localhost:8091/rest/v1.0/1/dialler/campaigns