...
This function retrieves all dialler campaigns from the client account.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/dialler/campaigns |
|
Parameters
None
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
...
Note, the dialler campaign array has been shortened for readability.
| Translations Ignore |
|---|
| Code Block |
|---|
| {
"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 Campaign by ID
...
Note, the dialler campaign array has been shortened for readability.
| Translations Ignore |
|---|
| Code Block |
|---|
| {
"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
} |
|
Retrieve Dialler Campaigns by Name
This function retrieves one or more dialler campaigns, depending on the passed name. If more than one campaign is available which matches the name passed (partial match), then all corresponding campaigns will be returned.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName} |
|
Parameters
| Parameter | Where | Type | Data |
|---|
| DiallerCampaignsName | Query | String | The name of the dialler campaign(s) to retrieve. |
...
Note, the dialler campaign data has been shortened for readability.
| Translations Ignore |
|---|
| Code Block |
|---|
| {
"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
} |
|
Retrieve the Result Codes from a Dialler Campaign
This function retrieves all result codes from a particular dialler campaign.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID} |
|
Parameters
| Parameter | Where | Type | Data |
|---|
| DiallerCampaignsID | URL | Integer | The ID of the dialler campaign for which to retrieve the result codes. |
| languagesID | Query | Integer | The ID of the language in which to retrieve the result codes. Currently supported: 1 = English 2 = German |
...
Note, the dialler campaign result codes array has been shortened for readability.
| Translations Ignore |
|---|
| Code Block |
|---|
| {
"records": [
{
"bDone": true,
"DiallerResultCodesTypesContent": "Abschluss",
"bDelay": false,
"DiallerCampaignsID": 535,
"DiallerResultCodesTypesShortText": "DiallerResultCodesTypes.1",
"bAllowDelete": true,
"ExportKey": "ABG",
"Content": "Abgeschlossen",
"ShortText": "DiallerCampaignsResultCodes.2695",
"bAborted": false,
"ID": 2695,
"bAgentBound": null,
"TimeOffset": null,
"bAppointment": false,
"DiallerResultCodesTypesID": 1
},
...
{
"bDone": false,
"DiallerResultCodesTypesContent": "Abbruch",
"bDelay": false,
"DiallerCampaignsID": 535,
"DiallerResultCodesTypesShortText": "DiallerResultCodesTypes.2",
"bAllowDelete": true,
"ExportKey": "Aufleger",
"Content": "Aufleger",
"ShortText": "DiallerCampaignsResultCodes.2698",
"bAborted": true,
"ID": 2698,
"bAgentBound": null,
"TimeOffset": null,
"bAppointment": false,
"DiallerResultCodesTypesID": 2
}
],
"count": 7,
"status": 200 |
|
Clone a Dialler Campaign
This function clones a dialler campaign including all related data except for the contacts in the campaign.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
POST {baseURL}/dialler/campaigns/clone |
|
POST Data
A JSON Structure containing the following parameters:
| Field | Type | Value |
|---|
| source | String | The name of the dialler campaign to clone. |
| destination | String | The name of the new destination campaign to create. |
| userData | String | UserData which can be associated with the newly cloned dialler campaign. |
Example:
| Translations Ignore |
|---|
| Code Block |
|---|
{
"source": "Campaign 1000",
"destination": "My New Campaign",
"userData": "UserData Field Contents"
} |
|
Responses
If the request is performed, 200 OK is returned.
...
Note, the dialler campaign data has been shortened for readability.
| Translations Ignore |
|---|
| Code Block |
|---|
| {
"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
} |
|
Delete a Dialler Campaign by ID
This function deletes a dialler campaign including all related data.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID} |
|
Parameters
| Parameter | Where | Type | Data |
|---|
| DiallerCampaignsID | URL | Integer | The ID of the dialler campaign to delete. |
...
This function deletes a dialler campaign including all related data.
URL
| Translations Ignore |
|---|
| Code Block |
|---|
DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName |
|
Parameters
| Parameter | Where | Type | Data |
|---|
| DiallerCampaignsName | Query | String | The name of the dialler campaign to delete. |
...
