Récupérer les contacts du composeur

Cette fonction permet de récupérer tous les contacts des composeurs à partir du compte client ou d'une campagne de composeurs spécifique.

URL

GET {baseURL}/dialler/contacts?diallerCampaignsID={diallerCampaignsID}

Paramètres

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 :

Exemple

Notez que le tableau des contacts du composeur a été raccourci pour plus de lisibilité.

{ "filter": "", "limitStart": 0, "limitPageSize": -1, "records": [ { "bLastResultMailbox": null, "bPhoneNumber3Invalid": null, "bPhoneNumber4Invalid": null, "Company": "Musterfirma GmbH", "ExternalSystemLink": "https://crm.mycrm.com?uid=123456789", "Email": null, "LastAcdAgentEndReasonsID": null, "Address": "Kunde", "bPhoneNumber6Invalid": null, "PhoneNumber2LastAcdAgentEndReasonsID": null, "dtNextTry": null, "bPhoneNumber5Invalid": null, "bPhoneNumber1Invalid": null, "bPhoneNumber2Invalid": null, "Name": "Mustermann", ... "nPhoneNumber4LastCause": null, "Model": null, "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": null } ], "count": 147, "orderBy": "Name", "ascending": true, "status": 200 }

Récupérer un contact téléphonique spécifique par ID

Cette fonction permet de retrouver un contact spécifique du composeur par ID.

URL

GET {baseURL}/dialler/contacts/{diallerContactsID}

Paramètres

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 le contact retourné.

Exemple

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

{ "records": [ { "bLastResultMailbox": null, "bPhoneNumber3Invalid": null, "bPhoneNumber4Invalid": null, "Company": "Musterfirma GmbH", "ExternalSystemLink": null, "Email": null, "LastAcdAgentEndReasonsID": null, "Address": null, "bPhoneNumber6Invalid": null, "PhoneNumber2LastAcdAgentEndReasonsID": null, "dtNextTry": null, "bPhoneNumber5Invalid": null, "bPhoneNumber1Invalid": null, "bPhoneNumber2Invalid": null, "Name": "Mustermann", "nTriesPhoneNumber5": 0, "nTriesPhoneNumber4": 0, "nTriesPhoneNumber6": 0, ... "nPhoneNumber6LastCause": null, "Model": null, "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": null } ], "count": 1, "status": 200 }

Récupérer les contacts du composeur par données d'utilisateur

Cette fonction permet de retrouver les contacts du composeur ayant la valeur UserData à rechercher.

URL

GET {baseURL}/dialler/contacts/contact?userData={userData}

Paramètres

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 le contact retourné.

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

{ "records": [ { "bLastResultMailbox": null, "bPhoneNumber3Invalid": null, "bPhoneNumber4Invalid": null, "Company": "Musterfirma GmbH", "ExternalSystemLink": null, "Email": null, "LastAcdAgentEndReasonsID": null, "Address": null, "bPhoneNumber6Invalid": null, "PhoneNumber2LastAcdAgentEndReasonsID": null, "dtNextTry": null, "bPhoneNumber5Invalid": null, "bPhoneNumber1Invalid": null, "bPhoneNumber2Invalid": null, "Name": "Mustermann", "nTriesPhoneNumber5": 0, "nTriesPhoneNumber4": 0, "nTriesPhoneNumber6": 0, ... "nPhoneNumber6LastCause": null, "Model": null, "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": null } ], "count": 1, "status": 200 }

Importer un Contact Composeur 

Cette fonction importe un contact d'appel dans une campagne de numérotation spécifique spécifiée par l'ID ou le nom de la campagne de numérotation.

URL

POST {baseURL}/dialler/contacts/import?overwriteDuplicates={overwriteDuplicates}

Paramètres

Après Données

Une structure JSON contenant le contact à importer.

Notez que les champs suivants sont obligatoires :

• Nom
• DiallerCampaignsID OU the DiallerCampaignsName
• Au moins une des
  • PhoneNumber1
  • ...
  • PhoneNumber6

Les autres champs peuvent être fournis ou laissés vides.

Exemple (tous les champs, fournir DiallerCampaignsID) :

{ 	"DiallerCampaignsID": 538, 	"RandomSortOrder": null, 	"UserData": "testUserData", 	"Client": "Client", 	"Service": "Service", 	"ReferenceNumber": "ReferenceNumber", 	"Name" : "Name", 	"FirstName" : "FirstName", 	"Salutation" : "Salutation", 	"Title" : "Title", 	"Company" : "Company", 	"Address" : "Address", 	"PostalCode" : "PostalCode", 	"City" : "City", 	"Country" : "Country", 	"AccountOwner" : "AccountOwner", 	"AccountBank" : "AccountBank", 	"AccountNationalBankCode" : "AccountNationalBankCode", 	"AccountBIC" : "AccountBIC", 	"AccountNumber" : "AccountNumber", 	"AccountIBAN" : "AccountIBAN", 	"Amount": 0.0, 	"PhoneNumber1" : "PhoneNumber1", 	"PhoneNumber2" : "PhoneNumber2", 	"PhoneNumber3" : "PhoneNumber3", 	"PhoneNumber4" : "PhoneNumber4", 	"PhoneNumber5" : "PhoneNumber5", 	"PhoneNumber6" : "PhoneNumber6", 	"FaxNumber" : "FaxNumber", 	"Email" : "Email", 	"Website" : "Website", 	"Comment" : "Comment", 	"ReservedUsersUID" : "ReservedUsersUID", 	"FollowUpUsersUID" : "FollowUpUsersUID", 	"FollowUpDateTime" : null, 	"dtBeginDate" : "2020-01-01T00:00:00", 	"dtEndDate" : "2020-03-01T00:00:00", 	"Manufacturer" : "Manufacturer", 	"Model" : "Model", 	"Tag": "Tag", 	"ExternalSystemLink": "http://test.external.link/" }

Exemple (raccourci, fournir DiallerCampaignsName) :

{ 	"DiallerCampaignsName": "My Campaign", 	"RandomSortOrder": null, 	"UserData": "testUserData", 	"Client": "Client", 	"Service": "Service", 	"ReferenceNumber": "ReferenceNumber", 	"Name" : "Name", ... 	"ExternalSystemLink": "http://test.external.link/" }

Réponses

Si la demande est exécutée, 200 OK sont renvoyés, renvoyant le contact importé ou déjà existant s'il s'agissait d'un double.

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 contact importé.

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

{ "records": [ { "bLastResultMailbox": null, "bPhoneNumber3Invalid": null, "bPhoneNumber4Invalid": null, "Company": "Company", "ExternalSystemLink": "http://test.external.link/", "Email": "Email", "LastAcdAgentEndReasonsID": null, ... "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": "Tag" } ], "count": 1, "status": 200 }

Mise à jour d'un Contact Composeur 

Cette fonction permet de mettre à jour un contact existant dans une campagne de numérotation spécifique spécifiée par l'ID ou les UserData, en fonction de ce qui est fourni dans les données de contact du JSON.

• Si l'ID est spécifié, alors cette fonction peut être utilisée pour mettre à jour le champ UserData, s'il est spécifié.
• Si seules les UserData sont spécifiées, alors le contact doit être trouvé par UserData. Notez qu'il n'est pas possible de déterminer exactement quel contact sera mis à jour si plus d'un contact existe avec la même valeur de champ UserData.
• Seuls les champs spécifiés dans la structure de données JSON pour le contact seront mis à jour.

URL

POST {baseURL}/dialler/contacts/update

Après Données

Une structure JSON contenant le contact à mettre à jour.

Notez que les champs suivants sont obligatoires :

• ID
• OU 
• UserData

Les autres champs peuvent être fournis ou laissés vides.

Exemple (tous les champs qui peuvent être mis à jour, fournir un ID) :

{ "ID": 123456, "UserData": "newUserData", "UserData2": "newUserData2", "UserData3": "newUserData3", "Client": "NewClient", "Service": "NewService", "ReferenceNumber": "NewReferenceNumber", "Name" : "NewName", "FirstName" : "NewFirstName", "Salutation" : "NewSalutation", "Title" : "NewTitle", "Company" : "NewCompany", "Address" : "NewAddress", "PostalCode" : "NewPostCode", "City" : "NewCity", "Country" : "NewCountry", "AccountOwner" : "NewAccountOwner", "AccountBank" : "NewAccountBank", "AccountNationalBankCode" : "NewAccountNationalBankCode", "AccountBIC" : "NewAccountBIC", "AccountNumber" : "NewAccountNumber", "AccountIBAN" : "NewAccountIBAN", "Amount": 999.99, "PhoneNumber1" : "NewPhoneNumber1", "PhoneNumber2" : "NewPhoneNumber2", "PhoneNumber3" : "NewPhoneNumber3", "PhoneNumber4" : "NewPhoneNumber4", "PhoneNumber5" : "NewPhoneNumber5", "PhoneNumber6" : "NewPhoneNumber6", "FaxNumber" : "NewFaxNumber", "Email" : "NewEmail", "Website" : "NewWebsite", "Comment" : "NewComment", "Region" : "NewRegion", "dtBeginDate" : "2030-01-01T00:00:00", "dtEndDate" : "2030-03-01T00:00:00", "Manufacturer" : "NewManufacturer", "Model" : "NewModel", "Tag": "NewTag", "ExternalSystemLink": "http://test.external.link/NewURL" }

Exemple (fournir les UserData, mise à jour partielle seulement) :

{ "UserData": "MyUserData", "Name" : "CorrectedName", "FirstName" : "CorrectedFirstName" }

Réponses

Si la demande est exécutée, 200 OK sont renvoyés, et le contact mis à jour 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 contact mis à jour.

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

{ "records": [ { "bLastResultMailbox": false, "bPhoneNumber3Invalid": false, "bPhoneNumber4Invalid": false, "Company": "Company", "ExternalSystemLink": "http://test.external.link/", "Email": "Email", "LastAcdAgentEndReasonsID": null, ... "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": "Tag" } ], "count": 1, "status": 200 }

Supprimer un contact composeur par ID

Cette fonction permet de supprimer un contact composeur, y compris toutes les données connexes.

URL

DELETE {baseURL}/dialler/contacts/contact/{diallerContactsID}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Supprimer un contact composeur par UserData

Cette fonction permet de supprimer un contact composeur, y compris toutes les données connexes en fournissant les UserData pour l'enregistrement à supprimer.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera supprimé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

DELETE /dialler/contacts/contact?userData={userData}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Verrouillage d'un composeur par ID

Cette fonction permet de verrouiller un contact du composeur par ID.

URL

PATCH {baseURL}/dialler/contacts/contact/{diallerContactsID}/lock

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Verrouillage d'un contact composeur par UserData

Cette fonction permet de verrouiller un contact du composeur par UserData.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera verrouillé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

PATCH {baseURL}/dialler/contacts/contact/lock?userData={userData}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Déverrouiller un contact composeur par ID

Cette fonction déverrouille un contact du composeur par ID.

URL

PATCH {baseURL}/dialler/contacts/contact/{diallerContactsID}/unlock

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Déverrouiller un contact composeur par UserData

Cette fonction déverrouille un contact du composeur par UserData.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera déverrouillé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

PATCH {baseURL}/dialler/contacts/contact/unlock?userData={userData}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Réinitialisation d'un contact Composeur par ID

Cette fonction permet de réinitialiser un contact du composeur par ID. La réinitialisation d'un contact du composeur met tous les compteurs d'essai d'appel, etc. à 0, de sorte que le contact est comme s'il venait d'être importé dans le composeur.

URL

PATCH {baseURL}/dialler/contacts/contact/{diallerContactsID}/reset

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Réinitialisation d'un contact téléphonique par UserData

Cette fonction permet de réinitialiser un contact de l'appelant par UserData. La réinitialisation d'un contact du composeur met tous les compteurs d'essai d'appel, etc. à 0, de sorte que le contact est comme s'il venait d'être importé dans le composeur.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera réinitialisé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

PATCH {baseURL}/dialler/contacts/contact/reset?userData={userData}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Récupérer l'historique des contacts du composeur par ID

Cette fonction récupère tout l'historique (appels et codes de résultats enregistrés) d'un contact du composeur, compte tenu de l'ID du contact du composeur.

URL

GET {baseURL}/dialler/contacts/contact/{diallerContactsID}/history

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le contact importé.

Exemple:

{ 	"records": [ 		{ 			"bOutbound": true, 			"dtCallEnd": "2020-11-11T15:31:47.070", 			"UserData": "Contact10", 			"ServiceNumbersID": 99, 			"DiallerCampaignsID": 551, 			"ANumber_CountryCodesID": 49, 			"BNumber_CountryCodesID": 49, 			"DiallerContactsID": 215220, 			"ANumber_AreaCodesID": 4645, 			"CONNRES": 1, 			"BNumber_AreaCodesID": 4645, 			"bCallerHangup": true, 			"ANumber": "49894614950703", 			"dtCallConnect": "2020-11-11T15:31:44.117", 			"dtCreatedDiallerContactsHistory": "2020-11-11T15:32:07.050", 			"CauseCodesID": 31, 			"dtCallAlert": "2020-11-11T15:31:43.190", 			"PhoneNumberOffset": 1, 			"DiallerCampaignsResultCodesID": 2811, 			"StatisticsPartAID": 223402, 			"UsersID": 3, 			"BNumber": "49894614950665", 			"UserData2": null, 			"ClientsID": 1, 			"UserData3": null, 			"dtCallStart": "2020-11-11T15:31:41.649", 			"bTestCall": false, 			"PhoneNumber": "49894614950703", 			"DiallerContactsHistoryID": 1136, 			"DiallerResultCodesTypesID": 3 		} 	], 	"count": 1, 	"status": 200 }

Récupérer l'historique des contacts du composeur par UserData

Cette fonction récupère tout l'historique (appels et codes de résultats enregistrés) pour tous les contacts du composeur avec une valeur particulière du champ UserData.

URL

GET {baseURL}/dialler/contacts/contact/history?userData={userData}

Paramètres

Réponses

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

Si le contact source n'existe pas, 404 Not Found est renvoyé.

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

Données retournées (200 OK)

Une structure JSON contenant le contact importé.