Sv translation

language	en

Table of Contents

maxLevel	1

Retrieve all Dialler Campaigns

This function retrieves all dialler campaigns from the client account.

URL

Translations Ignore

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:

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.

Translations Ignore

Code Block

language	js

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

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.

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

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.

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

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.

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:

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

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.

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

Translations Ignore

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

Sv translation

language	de

Status

colour	Red
title	This page is only available in English

Sv translation

language	fr

Table of Contents

maxLevel	1

Retrouvez toutes les campagnes du composeur

Cette fonction récupère toutes les campagnes de numérotation à partir du compte client.

URL

Translations Ignore

Code Block
GET {baseURL}/dialler/campaigns

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

Une structure JSON contenant les champs suivants :

Champ	Type	Données
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	DiallerCampaigns []	Un tableau de campagnes de numérotation
compter	Entier	Le nombre de campagnes de numérotation est revenu.
orderBy	Chaîne de caractères	Le terrain servait à trier les campagnes de numérotation.
ascendant	Booléen	Que l'éventail des campagnes soit 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 de la campagne de numérotation a été raccourci pour des raisons de lisibilité.

Translations Ignore

Code Block

language	js

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

Retrouvez une campagne de numérotation spécifique par ID

Cette fonction récupère une campagne de numérotation spécifique par ID.

URL

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

Paramètres

Paramètre	Où	Type	Données
DiallerCampaignsID	URL	Entier	L'ID du Composeur numérotation.

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 compagnes renvoyés.

Champ	Type	Données
enregistrements	DiallerCampaigns []	Un tablean de campagnes de numérotation, contenant une campagne.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau de la campagne de numérotation a été raccourci pour des raisons de lisibilité.

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 }

Récupérer les campagnes de numérotation par nom

Cette fonction permet de récupérer une ou plusieurs campagnes de numérotation, en fonction du nom passé. S'il existe plusieurs campagnes correspondant au nom transmis (correspondance partielle), toutes les campagnes correspondantes seront renvoyées.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
DiallerCampaignsName	Requête	Chaîne de caractères	Le nom de la (des) campagne(s) de numérotation à récupérer.

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 compagnes renvoyés.

Champ	Type	Données
enregistrements	DiallerCampaigns []	Un tablean de campagnes de numérotation, contenant une campagne.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que les données de la campagne de numérotation ont été raccourcies pour des raisons de lisibilité.

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 }

Récupérer les codes de résultats d'une campagne de numérotation

Cette fonction permet de récupérer tous les codes de résultat d'une campagne de numérotation particulier.

URL

Translations Ignore

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

Paramètres

Paramètre

Où

Type

Données

DiallerCampaignsID

URL

Entier

L'ID de la campagne de numérotation pour laquelle il faut récupérer les codes de résultat.

languagesID

Requête

Entier

L'ID de la langue dans laquelle récupérer les codes de résultat.

Actuellement pris en charge :

1 = English

2 = German

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 numérotation renvoyés.

Champ	Type	Données
enregistrements	DiallerCampaigns []	Un tableau de codes de résultats de la campagnes de numérotation.
compter	Entier	Le nombre de codes de résultat renvoyés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des codes de résultats de la campagne de numérotation a été raccourci pour des raisons de lisibilité.

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

Cloner un compagne numérotation

Cette fonction permet de cloner une campagne de numérotation comprenant toutes les données connexes sauf pour les contacts dans la campagne.

URL

Translations Ignore

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

Après Données

Une structure JSON contenant les paramètres suivants :

Champ	Type	Valeur
source	Chaîne de caractères	Le nom de la campagne de numérotation à cloner.
destination	Chaîne de caractères	Le nom de la nouvelle campagne de destination à créer.
userData	Chaîne de caractères	UserData qui peut être associé à la nouvelle campagne de numérotation cloné.

Exemple:

Translations Ignore

Code Block
{ "source": "Campaign 1000", "destination": "My New Campaign", "userData": "UserData Field Contents" }

Réponses

Si la demande est exécutée, 200 OK is returned.

Si la campagne source n'existe pas, 404 Not Found is returned.

Si la campagne de destination existe déjà, 409 Conflict is returned.

Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant la numérotation clonée.

Champ	Type	Données
enregistrements	DiallerCampaigns []	Un tablean de campagnes de numérotation, contenant une campagne.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que les données de la campagne de numérotation ont été raccourcies pour des raisons de lisibilité.

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 }

Supprimer une campagne de numérotation par ID

Cette fonction permet de supprimer une campagne de numérotation, y compris toutes les données connexes.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
DiallerCampaignsID	URL	Entier	L'ID du Composeur numérotation à supprimer.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si la campagne source n'existe pas, 404 Not Found est renvoyé.

Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Supprimer une campagne de numérotation par Nom

Cette fonction permet de supprimer une campagne de numérotation, y compris toutes les données connexes.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
DiallerCampaignsName	Requête	Chaîne de caractères	Le nom de la campagne de numérotation à supprimer.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si la campagne source n'existe pas, 404 Not Found est renvoyé.

Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Page tree

Page History

Versions Compared

Old Version 20

New Version Current

Key

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)

Retrouvez toutes les campagnes du composeur

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Retrouvez une campagne de numérotation spécifique par ID

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Récupérer les campagnes de numérotation par nom

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Récupérer les codes de résultats d'une campagne de numérotation

URL

Paramètres

Réponses

Données retournées (200 OK)

Exemple

Cloner un compagne numérotation

URL

Après Données

Réponses

Données retournées (200 OK)

Exemple

Supprimer une campagne de numérotation par ID

URL

Paramètres

Réponses