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
Retrieve a specific ACD Group by IDThis function retrieves a specific ACD group by ID. URL
Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Where | Type | Data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcdGroupsID | URL | Integer | The ID of the ACD Group. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field | Type | Data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
records | AcdGroups [] | An array of ACD groups, containing one group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
count | Integer | 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | Integer | The return code (also provided by the http status code). |
Sv translation | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Sv translation | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Récupérer tous les AcdEventTypesCette fonction récupère tous les AcdEventTypes du système. URL
ParamètresAucun RéponsesSi la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles. Données retournées (200 OK)Une structure JSON contenant les champs suivants :
Exemple
Retrouvez tous les AcdEventStatusCette fonction récupère tous les AcdEventStatus du système. ExampleNote, the record array has been shortened for readability. Translations Ignore |
Retrieve ACD Group by NameThis function retrieves one or more ACD groups, depending on the passed name. If more than one group is available which matches the name passed (partial match), then all corresponding groups will be returned. URL
Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter | Where | Type | Data | |||||||||||||||||||||||||||||||||||||||||||||||||
AcdGroupsName | Query | String | The name of the acd group(s) to retrieve. |
|
Paramètres
Aucun
Réponses
Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.
Données retournées
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 acd groups.
Une structure JSON contenant les champs suivants :
ChampField | Type | DataDonnées |
---|---|---|
records | AcdGroup [] | An array of ACD groups. |
count | Integer | The number of records returned. |
status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.
Code Block | ||
---|---|---|
| ||
{
"records": [
{
"QueueMusicID4Sec": 10,
"SupervisorAggregationSkill5ID": null,
"DistributionAlgorithmID": 3,
...
"QueueOffhookAnnouncementID": null,
"bPositionAnnouncement3": false,
"TarifAnnouncementWavesID": null,
"bCallRedirectionAfterNumberAnnouncement": false
}
],
"count": 3,
"status": 200
} |
language | de |
---|
filtre | Chaîne de caractères | Le filtre appliqué. Il est réservé à un usage futur. |
limitStart | Entier | Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation future. |
limitPageSize | Entier | Le nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future. |
enregistrements | AcdEventStatus [] | Un tableau d' AcdEventTypes. |
compter | Entier | Le nombre d'enregistrements retournés. |
orderBy | Chaîne de caractères | Le champ utilisé pour trier les enregistrements. |
ascendant | Booléen | Si l'ensemble des enregistrements est trié de manière ascendante ou descendante. |
statut | Entier | Le code de retour (également fourni par le code de statut http). |
Exemple
Translations Ignore | |||||
---|---|---|---|---|---|
|
Table of Contents | ||
---|---|---|
|
Retrieve all Dialler Campaigns
This function retrieves all dialler campaigns from the client account.
URL
Code Block |
---|
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:
Example
Note, the dialler campaign array has been shortened for readability.
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.