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.

Functions

Dialler Campaigns

Retrieve all Dialler Campaigns in Account

GET {baseURL}/dialler/campaigns

Parameters

None

Returns

Retrieve a specific Dialler Campaign by ID

GET {baseURL}/dialler/campaigns/{DiallerCampaignsID}

Retrieve a specific Dialler Campaign by Name

GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName}

Retrieve the Result Codes for a Dialler Campaign

GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID}