...
| Code Block |
|---|
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID} |
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| DiallerCampaignsID |
...
| Integer | The ID of the Dialler Campaign. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
...
| Code Block |
|---|
GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName} |
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| DiallerCampaignsName | String | The name of the dialler campaign(s) to retrieve. |
...
Note, the dialler campaign array data has been shortened for readability.
...
| Code Block |
|---|
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID} |
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| languagesID | Integer | The ID of the language in which to retrieve the result codes. Currently supported: 1 = English 2 = German |
...
| 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
| 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:
| Code Block |
|---|
{
"source": "Campaign 1000",
"destination": "My New Campaign",
"userData": "UserData Field Contents"
} |
Responses
If the request is performed, 200 OK is returned.
If the source campaign does not exist, 404 Not Found is returned.
If the destination campaign already exists, 409 Conflict is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the cloned 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 data has been shortened for readability.
| 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
| Code Block |
|---|
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID} |
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| DiallerCampaignsID | Integer | The ID of the dialler campaign to delete. |
Responses
If the request is performed, 200 OK is returned.
If the campaign does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
| Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |
Delete a Dialler Campaign by Name
This function deletes a dialler campaign including all related data.
URL
| Code Block |
|---|
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsName} |
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| DiallerCampaignsName | String | The name of the dialler campaign to delete. |
Responses
If the request is performed, 200 OK is returned.
If the campaign does not exist, 404 Not Found is returned.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the status code.
| Field | Type | Data |
|---|---|---|
| status | Integer | The return code (also provided by the http status code). |