This function retrieves all dialler contacts from the client account.

URL

Translations Ignore

Code Block
GET {baseURL}/dialler/contacts

Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

...

Note, the dialler contact array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "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

Translations Ignore

Code Block
GET {baseURL}/dialler/contacts/{DiallerContactsID}

Parameters

Parameter	Where	Type	Data
DiallerContactsID	URL	Integer	The ID of the Dialler Contact.

...

Note, the dialler campaign array has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "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

Translations Ignore

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

Parameters

Parameter	Where	Type	Data
userData	Query	String	The userData of the dialler contacts to search for.

...

Note, the dialler contact data has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "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

Translations Ignore

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

Parameters

Parameter

Where

Type

Data

overwriteDuplicates

Query

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.

...

Example (all fields, provide DiallerCampaignsID):

Translations Ignore

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/"
}

Example (shortened, provide DiallerCampaignsName):

Translations Ignore

Code Block

{  
	"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.

...

Note, the dialler contact data has been shortened for readability.

Translations Ignore

Code Block

language	js

{
    "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
}

Delete a Dialler Contact by ID

This function deletes a dialler contact including all related data by ID.

URL

Translations Ignore

Code Block
DELETE {baseURL}/dialler/contacts/contact/{DiallerContactsID}

Parameters

Parameter	Where	Type	Data
DiallerContactsID	URL	Integer	The ID of the dialler contact to delete.

...

Note, if more than one record contains the same user data, the first one found in the database will be deleted. It is not possible to determine which contact this will actually be.

URL

Translations Ignore

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

Parameters

Parameter	Where	Type	Data
userData	Query	String	The UserData of the dialler contact to delete.

...

This function locks a dialler contact by ID.

URL

Translations Ignore

Code Block
PATCH {baseURL}/dialler/contacts/contact/{DiallerContactsID}/lock

Parameters

Parameter	Where	Type	Data
DiallerContactsID	URL	Integer	The ID of the dialler contact to lock.

...

Note, if more than one record contains the same user data, the first one found in the database will be locked. It is not possible to determine which contact this will actually be.

URL

Translations Ignore

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

Parameters

Parameter	Where	Type	Data
userData	Query	String	The userData of the contact to lock.

...

This function unlocks a dialler contact by ID.

URL

Translations Ignore

Code Block
PATCH {baseURL}/dialler/contacts/contact/{DiallerContactsID}/unlock

Parameters

Parameter	Where	Type	Data
DiallerContactsID	URL	Integer	The ID of the dialler contact to lock.

...

Note, if more than one record contains the same user data, the first one found in the database will be unlocked. It is not possible to determine which contact this will actually be.

URL

Translations Ignore

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

Parameters

Parameter	Where	Type	Data
userData	Query	String	The userData of the contact to lock.

...

Page tree

Versions Compared

Old Version 8

New Version 9

Key

URL

Parameters

Responses

Retrieve a specific Dialler Contact by ID

URL

Parameters

Retrieve Dialler Contacts by User Data

URL

Parameters

Import a Dialler Contact

URL

Parameters

Responses

Delete a Dialler Contact by ID

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters

Page tree

Page History

Versions Compared

Old Version 8

New Version 9

Key

URL

Parameters

Responses

Retrieve a specific Dialler Contact by ID

URL

Parameters

Retrieve Dialler Contacts by User Data

URL

Parameters

Import a Dialler Contact

URL

Parameters

Responses

Delete a Dialler Contact by ID

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters

URL

Parameters