Data Structures
Dialler Campaign
A Dialler Campaign is represented as a JSON Object as shown in the following example:
{
"ContactPreviewTime": 5,
"nMaxParallelLines": null,
"bCloseContactsOnIncomingCallsMatchCallerID": true,
"dtTo": null,
"LanguagesID": 2,
"bCallerIDActive": false,
"Name": "Campaign 1000",
"BusyTriesInSeriesMaximum": 2,
"RoutingApplicationsID": null,
"AutoDiallerAgentConnectedResultCodesID": null,
"ID": 510,
"bActiveCampaign": true,
"CallerID": null,
"CrmUrl": null,
"MaxReachedEndResultID": 2491,
"ForeignSystemID": "1000",
"GDPRAutomaticWavesID": null,
"bMasterCampaign": false,
"AcdAgentStatusIDPause": null,
"OpeningTimesID": null,
"PostCallInterval": 10,
"AutoDiallerIVRConnectedResultCodesID": null,
"bCloseContactsOnIncomingCallsMatchTACExportCode": false,
"bQueryExternalSystem": false,
"BusyTriesInSeriesDelaySeconds": 30,
"dtLastModified": "2019-10-23T01:29:44.125",
"AnsweringMachineWavesID": null,
"AbortExternalSystemResultCodesID": 2495,
"UserData": "User Data",
"SalesForceStatus": null,
"ServiceNumbersID": 6,
"AnsweringMachineResultCodesID": 2493,
"dtAutoDiallerNextTry": null,
"MaxRingTime": 30,
"AcdGroupsID": null,
"CustomAgentHomeFieldLayout": null,
"bReleaseCampaign": false,
"DiallerCampaignsType": null,
"bCloseContactsOnIncomingCalls": true,
"ContactTriesMaximum": 3,
"NotReachedDelayTimeSeconds": 5,
"bFoundInSalesForcePass": false,
"IncomingCallsTransactionCodesExportKeys": null,
"HolidayTimesID": null,
"ExternalSystemsQueryURL": null,
"AcdAgentStatusIDPostCall": null,
"bCloseContactsOnIncomingCallsMatchUserData": false,
"dtFrom": null,
"bTestCampaign": false,
"ClientsID": 1,
"AbortOnNoTelNumberResultCodesID": 2492,
"IncomingCallResultCodesID": 2494
}
Functions
Retrieve all Dialler Campaigns in Account
URL
GET {baseURL}/dialler/campaigns
Parameters
None
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
| Field | Type | Data |
|---|---|---|
| filter | String | The applied filter. This is reserved for future use. |
| limitStart | Integer | The first record index. Currently 0, reserved for future use. |
| limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
| records | DiallerCampaigns [] | An array of dialler campaigns. |
| count | Integer | The number of dialler campaigns returned. |
| orderBy | String | The field used to sort the dialler campaigns. |
| ascending | Boolean | Whether the array of campaigns is sorted ascending or descending. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the dialler campaign array has been shortened for readability.
{
"filter": "",
"limitStart": 0,
"limitPageSize": -1,
"records": [
{
"ContactPreviewTime": 5,
"nMaxParallelLines": null,
"bCloseContactsOnIncomingCallsMatchCallerID": true,
"dtTo": null,
"LanguagesID": 2,
"bCallerIDActive": false,
"Name": "Campaign 1000",
...
"ClientsID": 1,
"AbortOnNoTelNumberResultCodesID": 2492,
"IncomingCallResultCodesID": 2494
}
],
"count": 1,
"orderBy": "Name",
"ascending": true,
"status": 200
}
Retrieve a specific Dialler Campaigns by ID
URL
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID}
URL Parameters
The ID of the Dialler Campaign.
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the returned campaign.
| Field | Type | Data |
|---|---|---|
| records | DiallerCampaigns [] | An array of dialler campaigns, containing one campaign. |
| count | Integer | 1 |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the dialler campaign array has been shortened for readability.
{
"records": [
{
"ContactPreviewTime": 5,
"nMaxParallelLines": null,
"bCloseContactsOnIncomingCallsMatchCallerID": true,
"dtTo": null,
"LanguagesID": 2,
"bCallerIDActive": false,
"Name": "Campaign 1000",
...
"ClientsID": 1,
"AbortOnNoTelNumberResultCodesID": 2492,
"IncomingCallResultCodesID": 2494
}
],
"count": 1,
"status": 200
}