Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

...

Sv translation
languagefr

Table of Contents
maxLevel1

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

If the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

ChampTypeDonnées
filtreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.
limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrementsDiallerCampaigns []Un tableau de campagnes de numérotation
compterEntierLe nombre de campagnes de numérotation est revenu.
orderByChaîne de caractèresLe terrain servait à trier les campagnes de numérotation. 
ascendantBooléenQue l'éventail des campagnes soit trié de manière ascendante ou descendante.
statutEntierLe 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
languagejs
{ "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ètreTypeDonnées
DiallerCampaignsIDURLEntierL'ID du Composeur numérotation.

Réponses

If the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les compagnes renvoyés.

ChampTypeDonnées
enregistrementsDiallerCampaigns []Un tablean de campagnes de numérotation, contenant une campagne.
compterEntier1
statutEntierLe 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
languagejs
{ "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ètreTypeDonnées
DiallerCampaignsNameRequêteChaîne de caractèresLe nom de la (des) campagne(s) de numérotation à récupérer.

Réponses

If the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les compagnes renvoyés.

ChampTypeDonnées
enregistrementsDiallerCampaigns []Un tablean de campagnes de numérotation, contenant une campagne.
compterEntier1
statutEntierLe 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
languagejs
{ "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ètreTypeDonnées
DiallerCampaignsIDURLEntierL'ID de la campagne de numérotation pour laquelle il faut récupérer les codes de résultat.
languagesIDRequêteEntier

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

If the request is performedSi la demande est exécutée, 200 OK is returnedest renvoyé. See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les numérotation renvoyés.

ChampTypeDonnées
enregistrementsDiallerCampaigns []Un tableau de codes de résultats de la campagnes de numérotation.
compterEntierLe nombre de codes de résultat renvoyés.
statutEntierLe 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
languagejs
{ "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 :

ChampTypeValeur
sourceChaîne de caractèresLe nom de la campagne de numérotation à cloner.
destinationChaîne de caractèresLe nom de la nouvelle campagne de destination à créer.
UserDatauserDataChaîne de caractèresUserData 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.

See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

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

ChampTypeDonnées
enregistrementsDiallerCampaigns []Un tablean de campagnes de numérotation, contenant une campagne.
compterEntier1
statutEntierLe 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
languagejs
{ "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ètreTypeDonnées
DiallerCampaignsIDURLEntierL'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é.

See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

ChampTypeDonnées
statutEntierLe 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ètreTypeDonnées
DiallerCampaignsNameRequêteChaîne de caractèresLe 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é.

See Voir Return Codes for further possible status codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

ChampTypeDonnées
statutEntierLe code de retour (également fourni par le code de statut http).