Sv translation

language	en

Table of Contents

maxLevel	1

Retrieve all ACD Groups

This function retrieves all ACD groups from the client account.

URL

Translations Ignore

Code Block
GET {baseURL}/acd/groups

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	AcdGroups []	An array of ACD groups.
count	Integer	The number of records returned.
orderBy	String	The field used to sort the records.
ascending	Boolean	Whether the array of records is sorted ascending or descending.
status	Integer	The return code (also provided by the http status code).

Example

Note, the records array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "QueueMusicID4Sec": -1,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 1,
            "ServiceLevelSeconds": 30,
...
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 40,
    "orderBy": "Name",
    "ascending": true,
    "status": 200
}

Retrieve a specific ACD Group by ID

This function retrieves a specific ACD group by ID.

URL

Code Block
GET {baseURL}/acd/groups/group/{AcdGroupsID}

Parameters

Parameter	Where	Type	Data
AcdGroupsID	URL	Integer	The ID of the ACD Group.

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

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

Example

Note, the record array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "QueueMusicID4Sec": -1,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 1,
...
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve ACD Group by Name

This 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

Translations Ignore

Code Block
GET {baseURL}/acd/groups/group?name={AcdGroupsName}

Parameters

Parameter	Where	Type	Data
AcdGroupsName	Query	String	The name of the acd group(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 acd groups.

Field	Type	Data
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.

Translations Ignore

Code Block

language	js

{
    "records": [
        {
            "QueueMusicID4Sec": 10,
            "SupervisorAggregationSkill5ID": null,
            "DistributionAlgorithmID": 3,
...
            "QueueOffhookAnnouncementID": null,
            "bPositionAnnouncement3": false,
            "TarifAnnouncementWavesID": null,
            "bCallRedirectionAfterNumberAnnouncement": false
        }
    ],
    "count": 3,
    "status": 200
}

Sv translation

language	de

Status

colour	Red
title	This page is only available in English

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.

Sv translation

language	fr

Table of Contents

maxLevel	1

Retrieve all Dialler Campaigns

Retrouvez tous les groupes ACD

Cette fonction récupère tous les groupes ACD du compte clientThis function retrieves all dialler campaigns from the client account.

URL

Translations Ignore

Code Block
GET {baseURL}/dialleracd/campaignsgroups

Parameters

Paramètres

NoneAucun

Responses

Réponses

Si la demande est exécutéeIf the request is performed, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes.

Returned Data

pour d'autres codes de statut possibles.

Données retournées (200 OK)

A JSON Structure containing the following fieldsUne structure JSON contenant les champs suivants :

FieldChamp	Type	DataDonnées
filterfiltre	String	Chaîne de caractères	Le filtre appliqué. Il est réservé à un usage futurThe applied filter. This is reserved for future use.
limitStart	Integer	Entier	Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation futureThe first record index. Currently 0, reserved for future use.
limitPageSize	Integer	Entier	Le nombre d'enregistrementsThe 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

indique tous les enregistrements. Réservé pour une utilisation future.
enregistrements	AcdGroups []	Un ensemble de groupes ACD.
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

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilitéNote, the dialler campaign array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
 "QueueMusicID4Sec": -1, "SupervisorAggregationSkill5ID": null,       "DistributionAlgorithmID": 1, "ContactPreviewTimeServiceLevelSeconds": 530,
 ...           "nMaxParallelLines"bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null,
 "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 40, "orderBy":     "bCloseContactsOnIncomingCallsMatchCallerID"Name", "ascending": true,
 "status":           "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

Parameter

Where

Type

Data

DiallerCampaignsID

URL

Integer

The ID of the Dialler 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).

Translations Ignore

Code Block

language	js

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

200 }

Retrouvez un groupe spécifique d'ACD par ID

Cette fonction permet de retrouver un groupe spécifique d'ACD par ID.

URL

Code Block
GET {baseURL}/acd/groups/group/{AcdGroupsID}

Paramètres

Paramètre	Où	Type	Données
AcdGroupsID	URL	Entier	L'ID du groupe ACD

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 (200 OK)

Une structure JSON contenant les données renvoyées.

Champ	Type	Données
enregistrements	AcdGroups []	Un ensemble de groupes ACD, contenant un groupe.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau d'enregistrement a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "QueueMusicID4Sec": -1, "SupervisorAggregationSkill5ID": null, "DistributionAlgorithmID": 1, ... "bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null, "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 1, "status": 200 }

Retrouvez le groupe ACD par son nom

Cette fonction récupère un ou plusieurs groupes ACD, selon le nom passé. S'il existe plusieurs groupes correspondant au nom transmis (correspondance partielle), tous les groupes correspondants seront renvoyés

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

Translations Ignore

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

Parameters

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

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.countInteger1statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign data has been shortened for readability.

Translations Ignore

Code Block

language	js

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

Translations Ignore

Code Block
GET {baseURL}/dialler/campaigns/campaign/{DiallerCampaignsID}/resultCodes?languagesID={LanguagesID}

Parameters

ParameterWhereTypeDataDiallerCampaignsIDURLIntegerThe ID of the dialler campaign for which to retrieve the result codes.languagesIDQueryInteger

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.

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaign result codes.countIntegerThe number of returned result codes.statusIntegerThe return code (also provided by the http status code).

Example

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

Translations Ignore

Code Block

language	js

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

Translations Ignore

Code Block
POST {baseURL}/dialler/campaigns/clone

POST Data

A JSON Structure containing the following parameters:

FieldTypeValuesourceStringThe name of the dialler campaign to clone.destinationStringThe name of the new destination campaign to create.userDataStringUserData 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" }

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.

FieldTypeDatarecordsDiallerCampaigns []An array of dialler campaigns, containing one campaign.countInteger1statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler campaign data has been shortened for readability.

Translations Ignore

Code Block

language	js

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

Translations Ignore

Code Block
DELETEGET {baseURL}/dialleracd/campaigns/campaign/{DiallerCampaignsIDgroups/group?name={AcdGroupsName}

Parameters

Paramètres

Parameter Paramètre	WhereOù	Type	DataDonnées
DiallerCampaignsIDAcdGroupsName	URLRequête	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

Chaîne de caractères

Le nom du (des) groupe(s) acd à retrouver.

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 (200 OK)

A JSON Structure containing the status code.

Une structure JSON contenant les groupes acd retournés.

ChampField	Type	DataDonnées
statusenregistrements	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

Translations Ignore

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

AcdGroups []	Un ensemble de groupes ACD.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des enregistrements a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "QueueMusicID4Sec": 10, "SupervisorAggregationSkill5ID": null, "DistributionAlgorithmID": 3, ... "QueueOffhookAnnouncementID": null, "bPositionAnnouncement3": false, "TarifAnnouncementWavesID": null, "bCallRedirectionAfterNumberAnnouncement": false } ], "count": 3, "status": 200 }

Parameters

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

FieldTypeDatastatusIntegerThe return code (also provided by the http status code).

Page tree

Page History

Versions Compared

Old Version 3

New Version Current

Key

Retrieve all ACD Groups

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific ACD Group by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve ACD Group by Name

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve all Dialler Campaigns

Retrouvez tous les groupes ACD

URL

Paramètres

Responses

Réponses

Données retournées (200 OK)

Example

Exemple

Retrieve a specific Dialler Campaign by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrouvez un groupe spécifique d'ACD par ID

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Retrouvez le groupe ACD par son nom

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

Paramètres

Responses

Réponses

Données retournées (200 OK)

Delete a Dialler Campaign by Name

URL

Exemple

Parameters

Responses

Returned Data (200 OK)