Retrieve Dialler Contacts

This function retrieves all dialler contacts from the client account or from a specific dialler campaign.

URL

POST {baseURL}/dialler/contacts

Parameters

Parameter

Where

Type

Data

languagesIDQueryInteger

The ID of the Language in which to return the texts associated with the result data.

UserData and IDsBodyJSON

A UserData list and / or a list of DiallerContactIDs specifying the contacts for which the information should be retrieved.

Example:

{
    "UserDataList" : [ "CON6174", "CON1234" ],
    "IDList": [ 215387, 215388, 215389, 215391, 215394 ]
}


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

countIntegerThe number of records retrieved.
statusIntegerThe return code (also provided by the http status code).
recordsDiallerContactsExtendedData []An array of dialler contacts extended data. See below for details.

Example

Note, the data has been shortened for readability, and the bracketed in formation shows which table the data is retrieved from.

{
    "records": [
        {
			"ID": 215395,
            "Name": "TestContact",
            "FirstName": "A",
			... 
			(All fields from DiallerContacts)
			...
			
			(The current result code)
			"DiallerCampaignsResultCodesID": 2881,
            "DiallerCampaignsResultCodes": {
                "bDone": false,
                "ExportKey": "Max Tries (Abort)",
                "Content": "Max Tries (Abort)",
                "bDelay": false,
                "bAborted": true,
                "ID": 2881,
                "bAppointment": false
            },
            
            "DiallerContactsHistory": [
                {
                    "StatisticsPartA": {
                        "ID": 409989,
                        "bOutbound": true,
						...
						(All fields from StatisticsPartA)
                    },
                    "nResultCodesTries": 0,
                    "nResultCodesResult": 0,
                    "PhoneNumberOffset": 1,
                    "StatisticsPartAID": 409989,
                    "UsersID": 3,
                    "dtCreated": "2024-09-26T08:36:45.241",
                    "DiallerContactsID": 215387,
					
					(The result recorded for that call)
                    "DiallerCampaignsResultCodesID": 2877,
                    "DiallerCampaignsResultCodes": {
                        "bDone": true,
                        "ExportKey": "Success (Done)",
                        "Content": "Abgeschlossen",
                        "bAborted": false,
                        "bDelay": false,
                        "ID": 2877,
                        "bAppointment": false
                    },
                    "PhoneNumber": "+49899540057006",
                    "ID": 1477,
                    "dtResultCodesTry": "2024-09-26T08:36:37.568",
                    "DiallerResultCodesTypesID": 1,
                    "dtLastModified": "2024-09-26T08:36:45.241"
                },
				...
				(All entries from DiallerContactsHistory together with their associated data from StatisticsPartA and DiallerCampaignsResultCodes)
            ],
        },

       ...
       (Records for all specified and found dialler contacts)
       ...
    ],
    "count": 7,
    "status": 200
}
  • No labels