Retrieve all Dialler Campaigns

This function retrieves all dialler campaigns from the client 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 Campaign by ID

This function retrieves a specific dialler campaign by ID.

URL

GET {baseURL}/dialler/campaigns/{DiallerCampaignsID}

Parameters

Parameter	Where	Type	Data
DiallerCampaignsID	URL	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.

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
}

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

GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName}

Parameters

Parameter	Where	Type	Data
DiallerCampaignsName	Query	String	The name of the dialler campaign(s) to retrieve.

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 data 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
}

Retrieve the Result Codes from a Dialler Campaign

This function retrieves all result codes from a particular dialler campaign.

URL

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

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 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).

Example

Note, the dialler campaign result codes array has been shortened for readability.

{
    "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

POST {baseURL}/dialler/campaigns/clone

POST Data

A JSON Structure containing the following parameters:

Field	From Release	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.
dtFrom	3.39	Date / Time	Is used as the value for dtFrom in the campaign if specified.
dtTo	3.39	Date / Time	Is used as the value for dtTo in the campaign if specified.

Example:

{  
	"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.

{
     "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

DELETE {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}

Parameters

Parameter	Where	Type	Data
DiallerCampaignsID	URL	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

DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName

Parameters

Parameter	Where	Type	Data
DiallerCampaignsName	Query	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).

Page tree

Dialler REST API - Dialler Campaign Functions

Retrieve all Dialler Campaigns

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific Dialler Campaign by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve Dialler Campaigns by Name

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve the Result Codes from a Dialler Campaign

URL

Parameters

Responses

Returned Data (200 OK)

Example

Clone a Dialler Campaign

URL

POST Data

Responses

Returned Data (200 OK)

Example

Delete a Dialler Campaign by ID

URL

Parameters

Responses

Returned Data (200 OK)

Delete a Dialler Campaign by Name

URL

Parameters

Responses

Returned Data (200 OK)