Retrieve all Dialler Contacts
This function retrieves all dialler contacts from the client account.
URL
GET {baseURL}/dialler/contacts
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 contact array has been shortened for readability.
{
"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
}
Retrieve a specific Dialler Contact by ID
This function retrieves a specific dialler contact by ID.
URL
GET {baseURL}/dialler/contacts/{DiallerContactsID}
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| DiallerContactsID | Integer | The ID of the Dialler Contact. |
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 contact.
| Field | Type | Data |
|---|---|---|
| records | DiallerContacts [] | An array of dialler contacts, containing one contact. |
| 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.
{
"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
}
Retrieve Dialler Contacts by User Data
This function retrieves the dialler contacts given the UserData value to search for.
URL
GET {baseURL}/dialler/contacts/contact?userData={userData}
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| userData | String | The userData of the dialler contacts to search for. |
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 contacts.
| Field | Type | Data |
|---|---|---|
| records | DiallerContacts[] | An array of dialler contacts. |
| count | Integer | The number of records returned. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the dialler contact data has been shortened for readability.
{
"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
POST {baseURL}/dialler/contacts/import?overwriteDuplicates={overwriteDuplicates}
Query Parameters
| Parameter | Type | Data |
|---|---|---|
| overwriteDuplicates | Boolean | 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. |
Post Data
A JSON structure containing the contact to import.
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):
{
"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/"
}
Example (shortened, provide DiallerCampaignsName):
{
"DiallerCampaignsName": "My Campaign",
"RandomSortOrder": null,
"UserData": "testUserData",
"Client": "Client",
"Service": "Service",
"ReferenceNumber": "ReferenceNumber",
"Name" : "Name",
...
"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.
{
"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
}