Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieve all AcdEventTypesThis function retrieves all AcdEventTypes from the system. URL
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:
Example
Retrieve all AcdEventStatusThis function retrieves all AcdEventStatus from the system. URL
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:
Example
|
Sv translation | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Retrieve all Dialler CampaignsThis function retrieves all dialler campaigns from the client account. URL Translations Ignore |
ParametersNone ResponsesIf the request is performed, 200 OK is returned. See Return Codes for further possible
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). | ||||||
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
This function retrieves a specific dialler campaign by ID.
URL
Code Block |
---|
GET {baseURL}/dialler/campaigns/{DiallerCampaignsID} |
Parameters
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.
Example
Note, the dialler campaign array 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
} |
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
Code Block |
---|
GET {baseURL}/dialler/campaigns/campaign?name={DiallerCampaignsName} |
Parameters
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.
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
} |
Retrieve the Result Codes from a Dialler Campaign
This function retrieves all result codes from a particular dialler campaign.
URL
Code Block |
---|
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID} |
Parameters
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.
Example
Note, the dialler campaign result codes array has been shortened for readability.
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:
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.
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} |
Parameters
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.
Delete a Dialler Campaign by Name
This function deletes a dialler campaign including all related data.
URL
Code Block |
---|
DELETE {baseURL}/dialler/campaigns/campaign?name=DiallerCampaignsName |
Parameters
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.