This function retrieves all dialler campaigns from the client account.
|
None
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
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). |
Note, the dialler campaign array has been shortened for readability.
|
This function retrieves a specific dialler campaign by ID.
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID} |
Parameter | Where | Type | Data |
---|---|---|---|
DiallerCampaignsID | URL | Integer | The ID of the Dialler Campaign. |
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
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). |
Note, the dialler campaign array has been shortened for readability.
|
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.
|
Parameter | Where | Type | Data |
---|---|---|---|
DiallerCampaignsName | Query | String | The name of the dialler campaign(s) to retrieve. |
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
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). |
Note, the dialler campaign data has been shortened for readability.
|
This function retrieves all result codes from a particular dialler campaign.
|
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 |
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
A JSON Structure containing the returned result codes.
Field | Type | Data |
---|---|---|
records | DiallerCampaigns [] | An array of dialler campaign result codes. |
count | Integer | The number of returned result codes. |
status | Integer | The return code (also provided by the http status code). |
Note, the dialler campaign result codes array has been shortened for readability.
|
This function clones a dialler campaign including all related data except for the contacts in the campaign.
|
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:
|
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.
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). |
Note, the dialler campaign data has been shortened for readability.
|
This function deletes a dialler campaign including all related data.
|
Parameter | Where | Type | Data |
---|---|---|---|
DiallerCampaignsID | URL | Integer | The ID of the dialler campaign to delete. |
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.
A JSON Structure containing the status code.
Field | Type | Data |
---|---|---|
status | Integer | The return code (also provided by the http status code). |
This function deletes a dialler campaign including all related data.
|
Parameter | Where | Type | Data |
---|---|---|---|
DiallerCampaignsName | Query | String | The name of the dialler campaign to delete. |
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.
A JSON Structure containing the status code.
Field | Type | Data |
---|---|---|
status | Integer | The return code (also provided by the http status code). |