...
| Code Block | ||
|---|---|---|
| ||
{
"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
} |
Import a Dialler
...
Contact
This function imports a dialler contact into a specific dialler campaign specified by either the ID or name of the Dialler Campaign.
URL
| Code Block |
|---|
POST {baseURL}/dialler/contacts/import?overwriteDuplicates={overwriteDuplicates} |
...
Note that the following fields are mandatory:
- Name
- DiallerCampaignsID OR the DiallerCampaignsName
- At least one of
- PhoneNumber1
- ...
- PhoneNumber6
The other fields may be provided or left empty.
Example (all fields, provide DiallerCampaignsID):
| Code Block |
|---|
{
"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/"
} |
Responses
If the request is performed, 200 OK is returned, returning the imported or already existing contact if it was a duplicate.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the imported contact.
...
Example
Note, the dialler contact data has been shortened for readability.
| Code Block | ||
|---|---|---|
| ||
{
"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
} |
Import a Dialler Contact by Dialler Campaign Name
This function imports a dialler contact into a specific dialler campaign specified by ID.
URL
| Code Block |
|---|
POST {baseURL}/dialler/contacts/import?overwriteDuplicates={overwriteDuplicates} |
Query Parameters
...
Whether to overwrite duplicate contacts.
If this is true, existing contact data will be overwritten when a match on the UserData field is detected.
If this is false, the new contact will be created whether a matching record is found or not.
Example (shortened, provide DiallerCampaignsName):
| Code Block |
|---|
{
"DiallerCampaignsName": "My Campaign",
"RandomSortOrder" |
Post Data
A JSON structure containing the contact to import.
Note that the following fields are mandatory:
- Name
- DiallerCampaignsName
- At least one of
- PhoneNumber1
- ...
- PhoneNumber6
The other fields may be provided or left empty.
Example (all fields):
| Code Block |
|---|
{ "DiallerCampaignsName": "My Campaign Name", "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, "dtBeginDateUserData" : "2020-01-01T00:00:00testUserData", "dtEndDateClient" : "2020-03-01T00:00:00Client", "ManufacturerService" : "ManufacturerService", "ModelReferenceNumber" : "ModelReferenceNumber", "TagName" : "TagName", ... "ExternalSystemLink": "http://test.external.link/" } |
Responses
If the request is performed, 200 OK is returned, returning the imported or already existing contact if it was a duplicate.
See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the imported contact.
| Field | Type | Data |
|---|---|---|
| records | DiallerContacts[] | An array of dialler contacts. |
| count | Integer | 1 |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the dialler contact data has been shortened for readability.
...