Retrieve all Dialler CampaignsThis function retrieves all dialler campaigns from the client account. URL Translations Ignore |
---|
Code Block |
---|
GET {baseURL}/dialler/campaigns |
|
ParametersNone ResponsesIf 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). |
ExampleNote, 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 IDThis function retrieves a specific dialler campaign by ID. URL Code Block |
---|
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID} |
ParametersParameter | Where | Type | Data |
---|
DiallerCampaignsID | URL | Integer | The ID of the Dialler Campaign. |
ResponsesIf 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). |
ExampleNote, 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 NameThis 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} |
|
ParametersParameter | Where | Type | Data |
---|
DiallerCampaignsName | Query | String | The name of the dialler campaign(s) to retrieve. |
ResponsesIf 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). |
ExampleNote, 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 CampaignThis function retrieves all result codes from a particular dialler campaign. URL Translations Ignore |
---|
Code Block |
---|
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID} |
|
ParametersParameter | 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 |
ResponsesIf 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 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). |
ExampleNote, 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 CampaignThis 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 DataA 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"
} |
|
ResponsesIf 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). |
ExampleNote, 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 IDThis function deletes a dialler campaign including all related data. URL Translations Ignore |
---|
Code Block |
---|
DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID} |
|
ParametersParameter | Where | Type | Data |
---|
DiallerCampaignsID | URL | Integer | The ID of the dialler campaign to delete. |
ResponsesIf 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 NameThis function deletes a dialler campaign including all related data. URL Translations Ignore |
---|
Code Block |
---|
DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName |
|
ParametersParameter | Where | Type | Data |
---|
DiallerCampaignsName | Query | String | The name of the dialler campaign to delete. |
ResponsesIf 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). |
|