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 campaign.
| 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
}