Retrouvez toutes les campagnes du composeurCette fonction récupère toutes les campagnes de numérotation à partir du compte client. URL Translations Ignore |
---|
Code Block |
---|
GET {baseURL}/dialler/campaigns |
|
ParamètresAucun RéponsesIf 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 : 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). |
ExempleNotez que le tableau de la campagne de numérotation a été raccourci pour des raisons de lisibilité. 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 } |
|
Retrouvez une campagne de numérotation spécifique par IDCette 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éponsesIf 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. 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). |
ExempleNotez que le tableau de la campagne de numérotation a été raccourci pour des raisons de lisibilité. Translations Ignore |
---|
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 } |
|
Récupérer les campagnes de numérotation par nomCette 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éponsesIf 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. 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). |
ExempleNotez que les données de la campagne de numérotation ont été raccourcies pour des raisons de lisibilité. Translations Ignore |
---|
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 } |
|
Récupérer les codes de résultats d'une campagne de numérotationCette 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éponsesIf 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. 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). |
ExempleNotez 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 |
---|
| { "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érotationCette 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éesUne 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. | UserDatauserData | 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éponsesSi 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. 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). |
ExempleNotez que les données de la campagne de numérotation ont été raccourcies pour des raisons de lisibilité. Translations Ignore |
---|
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 } |
|
Supprimer une campagne de numérotation par IDCette 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éponsesSi 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. 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 NomCette 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éponsesSi 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. Champ | Type | Données |
---|
statut | Entier | Le code de retour (également fourni par le code de statut http). |
|