Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Delete a Dialler Contact by UserData

This function deletes a dialler contact including all related data by providing the UserData for the record 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

Sv translation

language	en

Table of Contents

maxLevel	1

Retrieve

all

Dialler Contacts

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

URL

Translations Ignore

Code Block
GET {baseURL}/dialler/contacts

Parameters

None

?diallerCampaignsID={diallerCampaignsID}

Parameters

Parameter

Where

Type

Data

diallerCampaignsID

Query

Integer

The ID of the Dialler Campaign to retrieve the contacts from.

If not passed, all contacts in the client account will be retrieved.

Caution - this function will return a lot of data if the campaigns contain lots of contacts.

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.

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/{DiallerContactsIDdiallerContactsID}

Parameters

Parameter	Where	Type	Data
DiallerContactsIDdiallerContactsID	URL	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.

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.

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.

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

From Release

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.

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):

resetContact

Status

colour	Blue
title	3.39

Query

Boolean

If true, the contact is reset if it already existed. The result code, if recorded, is deleted and the number of dialling attempts is set to 0.
If false, the contact is not reset.
If not specified, the behaviour is as before (no change to the contact).
For contacts which do not yet exist (i.e. there is no duplicate), the newly created contact is already in the reset state.

unlockContact

Status

colour	Blue
title	3.39

Query

Boolean

If true, the contact is unlocked and is available in the Dialler.
If false, the contact is not unlocked.
If not specified, the behaviour is as before (the contact will be unlocked).
If the contact does not exist (i.e. there is no duplicate), the newly created contact is already unlocked.
(This parameter is a clarification of the previous behaviour so that a contact can be specifically not unlocked, as previously it was always unlocked).

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):

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"

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.

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	Integer1	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.

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

Update a Dialler

Contact by ID

Contact

This function deletes a dialler contact including all related data by ID.updates an existing dialler contact into a specific dialler campaign specified by either the ID or UserData, depending on what is supplied in the JSON contact data.

If the ID is specified, then this function can be used to update the UserData field, if specified.
If only UserData is specified, then the contact must be found by UserData. Note, that it is not possible to determine which contact exactly will be updated if more than one contact exists with the same UserData field value.
Only the fields specified in the JSON data structure for the contact will be updated.

URL

Translations Ignore

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

Parameters

Parameter

Where

Type

Data

DiallerContactsID

URL

Integer

The ID of the dialler contact to delete.

Field

Type

Data

status

Integer

The return code (also provided by the http status code).

Translations Ignore

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

Parameters

Parameter

Where

Type

Data

userDataQueryStringThe UserData of the dialler contact to delete.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Lock a Dialler Contact by ID

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

DiallerContactsIDURLIntegerThe ID of the dialler contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Lock a Dialler Contact by UserData

This function locks a dialler contact by UserData.

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

userDataQueryStringThe userData of the contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Unlock a Dialler Contact by ID

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

DiallerContactsIDURLIntegerThe ID of the dialler contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Unlock a Dialler Contact by UserData

This function unlocks a dialler contact by UserData.

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

userDataQueryStringThe userData of the contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code). Sv translation

language	de

update

Post Data

A JSON structure containing the contact to update.

Note that the following fields are mandatory:

ID
OR
UserData

The other fields may be provided or left empty.

Example (all fields which can be updated, provide ID):

Translations Ignore

Code Block

{ 
    "ID": 123456,
    "UserData": "newUserData",
    "UserData2": "newUserData2",
    "UserData3": "newUserData3",
    "Client": "NewClient",
    "Service": "NewService",
    "ReferenceNumber": "NewReferenceNumber",
    "Name" : "NewName",
    "FirstName" : "NewFirstName",
    "Salutation" : "NewSalutation",
    "Title" : "NewTitle",
    "Company" : "NewCompany",
    "Address" : "NewAddress",
    "PostalCode" : "NewPostCode",
    "City" : "NewCity",
    "Country" : "NewCountry",
    "AccountOwner" : "NewAccountOwner",
    "AccountBank" : "NewAccountBank",
    "AccountNationalBankCode" : "NewAccountNationalBankCode",
    "AccountBIC" : "NewAccountBIC",
    "AccountNumber" : "NewAccountNumber",
    "AccountIBAN" : "NewAccountIBAN",
    "Amount": 999.99,
    "PhoneNumber1" : "NewPhoneNumber1",
    "PhoneNumber2" : "NewPhoneNumber2",
    "PhoneNumber3" : "NewPhoneNumber3",
    "PhoneNumber4" : "NewPhoneNumber4",
    "PhoneNumber5" : "NewPhoneNumber5",
    "PhoneNumber6" : "NewPhoneNumber6",
    "FaxNumber" : "NewFaxNumber",
    "Email" : "NewEmail",
    "Website" : "NewWebsite",
    "Comment" : "NewComment",
    "Region" : "NewRegion",
    "dtBeginDate" : "2030-01-01T00:00:00",
    "dtEndDate" : "2030-03-01T00:00:00",
    "Manufacturer" : "NewManufacturer",
    "Model" : "NewModel",
    "Tag": "NewTag",
    "ExternalSystemLink": "http://test.external.link/NewURL"
}

Example (provide UserData, partial update only):

Translations Ignore

Code Block
{ "UserData": "MyUserData", "Name" : "CorrectedName", "FirstName" : "CorrectedFirstName" }

Responses

If the request is performed, 200 OK is returned, and the updated contact is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the updated contact.

Field	Type	Data
records	DiallerContacts[]	An array containing the updated contact.
count	Integer	The number of records returned (will always be 1).
status	Integer	The return code (also provided by the http status code).

Example

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

Translations Ignore

Code Block

language	js

{
    "records": [
        {

Table of Contents

maxLevel	1

Retrieve all Dialler Contacts

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.

Returned Data (200 OK)

A JSON Structure containing the following fields:

FieldTypeDatafilterStringThe applied filter. This is reserved for future use.limitStartIntegerThe first record index. Currently 0, reserved for future use.limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.recordsDiallerCampaigns []An array of dialler campaigns.countIntegerThe number of dialler campaigns returned.orderByStringThe field used to sort the dialler campaigns. ascendingBooleanWhether the array of campaigns is sorted ascending or descending.statusIntegerThe return code (also provided by the http status code).

Example

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,
            "bPhoneNumber5InvalidbLastResultMailbox": nullfalse,
            "bPhoneNumber1InvalidbPhoneNumber3Invalid": nullfalse,
            "bPhoneNumber2InvalidbPhoneNumber4Invalid": nullfalse,
            "NameCompany": "MustermannCompany",
            "ExternalSystemLink": "http://test.external..link/",
            "nPhoneNumber4LastCauseEmail": null"Email",
            "ModelLastAcdAgentEndReasonsID": null,
            ...
            "PhoneNumber3LastAcdAgentEndReasonsID": null,
            "Tag": null"Tag"
        }
    ],
    "count": 1471,
    "orderBystatus": "Name",
    "ascending": true,
    "status": 200
}

Retrieve a specific Dialler Contact by ID

200
}

Delete a Dialler Contact by ID

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

URL

Translations Ignore

Code Block
GETDELETE {baseURL}/dialler/contacts/contact/{DiallerContactsIDdiallerContactsID}

Parameters

DiallerContactsID Dialler Contact

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

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the returned contactstatus code.

1

Field	Type	Data
records	DiallerContacts []	An array of dialler contacts, containing one contact.
count	Integer

status	Integer	The return code (also provided by the http status code).

Example

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

Delete a Dialler Contact by UserData

This function deletes a dialler contact including all related data by providing the UserData for the record 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.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Lock a Dialler Contact by ID

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.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Lock a Dialler Contact by UserData

This function locks a dialler contact by UserData.

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.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Unlock a Dialler Contact by ID

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.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Unlock a Dialler Contact by UserData

This function unlocks a dialler contact by UserData.

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.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Reset a Dialler Contact by ID

This function reset a dialler contact by ID. Resetting a dialler contact sets all call try counters etc. to 0 so the contact is as if it was just imported to the dialler.

URL

Translations Ignore

Code Block
PATCH {baseURL}/dialler/contacts/contact/{diallerContactsID}/reset

Translations Ignore

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

Parameters

userDataQueryString userData contacts search for

Parameter	Where	Type	Data
diallerContactsID	URL	Integer	The	ID of the dialler	contact to	reset.

Responses

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

Returned Data

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the returned contactsstatus code.

An array of dialler contacts.

Field	Type	Data
records	DiallerContacts[]

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.

Reset a Dialler Contact by UserData

This function resets a dialler contact by UserData. Resetting a dialler contact sets all call try counters etc. to 0 so the contact is as if it was just imported to the dialler.

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

URL

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

ParameterWhereTypeDataoverwriteDuplicatesQueryBoolean

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):

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.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the imported contact.

FieldTypeDatarecordsDiallerContacts[]An array of dialler contacts.countInteger1statusIntegerThe return code (also provided by the http status code).

Example

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
}

PATCH {baseURL}/dialler/contacts/contact/reset?userData={userData}

Parameters

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

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field	Type	Data
status	Integer	The return code (also provided by the http status code).

Retrieve Dialler Contact History by ID

This function retrieves all history (calls and recorded result codes) for a dialler contact, given the dialler contact ID.

URL

Translations Ignore

Code Block
GET {baseURL}/dialler/contacts/contact/{diallerContactsID}/history

Parameters

Parameter	Where	Type	Data
diallerContactsID	URL	Integer	The ID of the dialler contact to retrieve the data from.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the imported contact.

Field	Type	Data
records	DiallerContactsHistory[]	An array of dialler contacts history.
count	Integer	The number of records returned.
status	Integer	The return code (also provided by the http status code).

Example:

Translations Ignore

Code Block

{
	"records": [
		{
			"bOutbound": true,
			"dtCallEnd": "2020-11-11T15:31:47.070",
			"UserData": "Contact10",
			"ServiceNumbersID": 99,
			"DiallerCampaignsID": 551,
			"ANumber_CountryCodesID": 49,
			"BNumber_CountryCodesID": 49,
			"DiallerContactsID": 215220,
			"ANumber_AreaCodesID": 4645,
			"CONNRES": 1,
			"BNumber_AreaCodesID": 4645,
			"bCallerHangup": true,
			"ANumber": "49894614950703",
			"dtCallConnect": "2020-11-11T15:31:44.117",
			"dtCreatedDiallerContactsHistory": "2020-11-11T15:32:07.050",
			"CauseCodesID": 31,
			"dtCallAlert": "2020-11-11T15:31:43.190",
			"PhoneNumberOffset": 1,
			"DiallerCampaignsResultCodesID": 2811,
			"StatisticsPartAID": 223402,
			"UsersID": 3,
			"BNumber": "49894614950665",
			"UserData2": null,
			"ClientsID": 1,
			"UserData3": null,
			"dtCallStart": "2020-11-11T15:31:41.649",
			"bTestCall": false,
			"PhoneNumber": "49894614950703",
			"DiallerContactsHistoryID": 1136,
			"DiallerResultCodesTypesID": 3
		}
	],
	"count": 1,
	"status": 200
}

Retrieve Dialler Contact History by UserData

This function retrieves all history (calls and recorded result codes) for all dialler contacts with a particular UserData field value.

URL

Translations Ignore

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

Parameters

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

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the imported contact.

Field	Type	Data
records	DiallerContactsHistory[]	An array of dialler contacts history.
count	Integer	The number of records returned.
status	Integer	The return code (also provided by the http status code).

Sv translation

language	de

Status

colour	Red
title	This page is only available in English

Sv translation

language	fr

Table of Contents

maxLevel	1

Récupérer les contacts du composeur

Cette fonction permet de récupérer tous les contacts des composeurs à partir du compte client ou d'une campagne de composeurs spécifique.

URL

Translations Ignore

Code Block
GET {baseURL}/dialler/contacts?diallerCampaignsID={diallerCampaignsID}

Paramètres

Paramètre

Où

Type

Données

diallerCampaignsID

Requête

Entier

L'ID de la Campagne de numérotation pour récupérer les contacts.

En cas d'échec, tous les contacts du compte client seront récupérés.

Attention - cette fonction renvoie beaucoup de données si les campagnes contiennent beaucoup de contacts.

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

Champ	Type	Données
filtre	Chaîne de caractères	Le filtre appliqué. Il est réservé à un usage futur.
limitStart	Entier	Le premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.
limitPageSize	Entier	Le nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.
enregistrements	DiallerCampaigns []	Un tableau de campagnes de numérotation
compter	Entier	Le nombre de campagnes de numérotation est revenu.
orderBy	Chaîne de caractères	Le terrain servait à trier les campagnes de numérotation.
ascendant	Booléen	Que l'éventail des campagnes soit trié de manière ascendante ou descendante.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau des contacts du composeur a été raccourci pour plus de lisibilité.

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 }

Récupérer un contact téléphonique spécifique par ID

Cette fonction permet de retrouver un contact spécifique du composeur par ID.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
diallerContactsID	URL	Entier	L'ID du Contact Composeur

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le contact retourné.

Champ	Type	Données
enregistrements	DiallerContacts []	Un tableau de contacts du composeur, contenant un contact.
compter	Entier	1
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que le tableau de la campagne de numérotation a été raccourci pour des raisons de lisibilité.

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 }

Récupérer les contacts du composeur par données d'utilisateur

Cette fonction permet de retrouver les contacts du composeur ayant la valeur UserData à rechercher.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
userData	Requête	Chaîne de caractères	UserData des contacts du composeur à rechercher.

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le contact retourné.

Champ	Type	Données
enregistrements	DiallerContacts []	Un tableau des contacts du composeur.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

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 }

Importer un Contact Composeur

Cette fonction importe un contact d'appel dans une campagne de numérotation spécifique spécifiée par l'ID ou le nom de la campagne de numérotation.

URL

Translations Ignore

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

Paramètres

Paramètre

Où

Type

Données

overwriteDuplicates

Requête

Booléen

S'il faut écraser les contacts en double.

Si cela est vrai, les données de contact existantes seront écrasées lorsqu'une correspondance sera détectée dans le champ UserData.

Si cela est faux, le nouveau contact sera créé, qu'un enregistrement correspondant soit trouvé ou non.

Après Données

Une structure JSON contenant le contact à importer.

Notez que les champs suivants sont obligatoires :

Nom
DiallerCampaignsID OU the DiallerCampaignsName
Au moins une des
- PhoneNumber1
- ...
- PhoneNumber6

Les autres champs peuvent être fournis ou laissés vides.

Exemple (tous les champs, fournir 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/" }

Exemple (raccourci, fournir 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/" }

Réponses

Si la demande est exécutée, 200 OK sont renvoyés, renvoyant le contact importé ou déjà existant s'il s'agissait d'un double.

Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le contact importé.

Champ	Type	Données
enregistrements	DiallerContacts []	Un tableau des contacts du composeur.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

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 }

Mise à jour d'un Contact Composeur

Cette fonction permet de mettre à jour un contact existant dans une campagne de numérotation spécifique spécifiée par l'ID ou les UserData, en fonction de ce qui est fourni dans les données de contact du JSON.

Si l'ID est spécifié, alors cette fonction peut être utilisée pour mettre à jour le champ UserData, s'il est spécifié.
Si seules les UserData sont spécifiées, alors le contact doit être trouvé par UserData. Notez qu'il n'est pas possible de déterminer exactement quel contact sera mis à jour si plus d'un contact existe avec la même valeur de champ UserData.
Seuls les champs spécifiés dans la structure de données JSON pour le contact seront mis à jour.

URL

Translations Ignore

Code Block
POST {baseURL}/dialler/contacts/update

Après Données

Une structure JSON contenant le contact à mettre à jour.

Notez que les champs suivants sont obligatoires :

ID
OU
UserData

Les autres champs peuvent être fournis ou laissés vides.

Exemple (tous les champs qui peuvent être mis à jour, fournir un ID) :

Translations Ignore

Code Block

{ "ID": 123456, "UserData": "newUserData", "UserData2": "newUserData2", "UserData3": "newUserData3", "Client": "NewClient", "Service": "NewService", "ReferenceNumber": "NewReferenceNumber", "Name" : "NewName", "FirstName" : "NewFirstName", "Salutation" : "NewSalutation", "Title" : "NewTitle", "Company" : "NewCompany", "Address" : "NewAddress", "PostalCode" : "NewPostCode", "City" : "NewCity", "Country" : "NewCountry", "AccountOwner" : "NewAccountOwner", "AccountBank" : "NewAccountBank", "AccountNationalBankCode" : "NewAccountNationalBankCode", "AccountBIC" : "NewAccountBIC", "AccountNumber" : "NewAccountNumber", "AccountIBAN" : "NewAccountIBAN", "Amount": 999.99, "PhoneNumber1" : "NewPhoneNumber1", "PhoneNumber2" : "NewPhoneNumber2", "PhoneNumber3" : "NewPhoneNumber3", "PhoneNumber4" : "NewPhoneNumber4", "PhoneNumber5" : "NewPhoneNumber5", "PhoneNumber6" : "NewPhoneNumber6", "FaxNumber" : "NewFaxNumber", "Email" : "NewEmail", "Website" : "NewWebsite", "Comment" : "NewComment", "Region" : "NewRegion", "dtBeginDate" : "2030-01-01T00:00:00", "dtEndDate" : "2030-03-01T00:00:00", "Manufacturer" : "NewManufacturer", "Model" : "NewModel", "Tag": "NewTag", "ExternalSystemLink": "http://test.external.link/NewURL" }

Exemple (fournir les UserData, mise à jour partielle seulement) :

Translations Ignore

Code Block
{ "UserData": "MyUserData", "Name" : "CorrectedName", "FirstName" : "CorrectedFirstName" }

Réponses

Si la demande est exécutée, 200 OK sont renvoyés, et le contact mis à jour est renvoyé.

Voir Return Codes pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le contact mis à jour.

Champ	Type	Données
enregistrements	DiallerContacts []	Un tableau contenant le contact mis à jour.
compter	Entier	Le nombre d'enregistrements retournés (sera toujours 1).
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple

Notez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

Translations Ignore

Code Block

language	js

{ "records": [ { "bLastResultMailbox": false, "bPhoneNumber3Invalid": false, "bPhoneNumber4Invalid": false, "Company": "Company", "ExternalSystemLink": "http://test.external.link/", "Email": "Email", "LastAcdAgentEndReasonsID": null, ... "PhoneNumber3LastAcdAgentEndReasonsID": null, "Tag": "Tag" } ], "count": 1, "status": 200 }

Supprimer un contact composeur par ID

Cette fonction permet de supprimer un contact composeur, y compris toutes les données connexes.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
diallerContactsID	URL	Entier	L'ID du contact du composeur à supprimer.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Supprimer un contact composeur par UserData

Cette fonction permet de supprimer un contact composeur, y compris toutes les données connexes en fournissant les UserData pour l'enregistrement à supprimer.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera supprimé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
userData	Requête	Chaîne de caractères	L'UserData du contact du composeur à supprimer.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Verrouillage d'un composeur par ID

Cette fonction permet de verrouiller un contact du composeur par ID.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
diallerContactsID	URL	Entier	L'ID du contact du composeur à verrouiller.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Verrouillage d'un contact composeur par UserData

Cette fonction permet de verrouiller un contact du composeur par UserData.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera verrouillé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
userData	Requête	Chaîne de caractères	UserData du contact à verrouiller.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Déverrouiller un contact composeur par ID

Cette fonction déverrouille un contact du composeur par ID.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
diallerContactsID	URL	Entier	L'ID du contact du composeur à verrouiller.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Déverrouiller un contact composeur par UserData

Cette fonction déverrouille un contact du composeur par UserData.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera déverrouillé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

Translations Ignore

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

Paramètres

Paramètre	Où	Type	Données
userData	Requête	Chaîne de caractères	UserData du contact à verrouiller.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Réinitialisation d'un contact Composeur par ID

Cette fonction permet de réinitialiser un contact du composeur par ID. La réinitialisation d'un contact du composeur met tous les compteurs d'essai d'appel, etc. à 0, de sorte que le contact est comme s'il venait d'être importé dans le composeur.

URL

Translations Ignore

Code Block
PATCH {baseURL}/dialler/contacts/contact/{diallerContactsID}/reset

Paramètres

Paramètre	Où	Type	Données
diallerContactsID	URL	Entier	L'ID du contact du composeur à réinitialiser.

Réponses

Si la demande est exécutée, 200 OK est renvoyé.

Si le contact source n'existe pas, 404 Not Found est renvoyé.

Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

Une structure JSON contenant le code de statut.

Champ	Type	Données
statut	Entier	Le code de retour (également fourni par le code de statut http).

Réinitialisation d'un contact téléphonique par UserData

Cette fonction permet de réinitialiser un contact de l'appelant par UserData. La réinitialisation d'un contact du composeur met tous les compteurs d'essai d'appel, etc. à 0, de sorte que le contact est comme s'il venait d'être importé dans le composeur.

Notez que si plusieurs enregistrements contiennent les mêmes données utilisateur, le premier trouvé dans la base de données sera réinitialisé. Il n'est pas possible de déterminer quel contact il s'agira réellement.

URL

Translations Ignore

Code Block
PATCH

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/reset?userData={DiallerContactsIDuserData}

Parameters

Paramètres

Parameter Paramètre	WhereOù	Type	DataDonnées
DiallerContactsIDuserData	URLRequête	Integer	The ID of the dialler contact to delete.

Responses

Chaîne de caractères

L' userData du contact à réinitialiser.

Réponses

Si la demande est exécutéeIf the request is performed, 200 OK is returnedest renvoyé.

If the contact does not existSi le contact source n'existe pas, 404 Not Found is returnedest renvoyé.

See Return Voir Codes for further possible status codes.

Returned Data

de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

A JSON Structure containing the status code.

Une structure JSON contenant le code de statut.

ChampField	Type	DataDonnées
statusstatut	IntegerEntier	The return Le code (also provided by the http status code).

Delete a Dialler Contact by UserData

This function deletes a dialler contact including all related data by providing the UserData for the record to delete.

de retour (également fourni par le code de statut http).

Récupérer l'historique des contacts du composeur par ID

Cette fonction récupère tout l'historique (appels et codes de résultats enregistrés) d'un contact du composeur, compte tenu de l'ID du contact du composeurNote, 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
DELETEGET {baseURL}/dialler/contacts/contact?userData=/{userDatadiallerContactsID}/history

Parameters

Paramètres

Parameter Paramètre	WhereOù	Type	DataDonnées
userDatadiallerContactsID	QueryURL	String	The UserData of the dialler contact to delete.

Responses

Entier

L'ID du contact du composeur pour récupérer les données.

Réponses

Si la demande est exécutéeIf the request is performed, 200 OK is returnedest renvoyé.

If the contact does not existSi le contact source n'existe pas, 404 Not Found is returnedest renvoyé.

See Return Voir Codes for further possible status codes.

Returned Data

de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

A JSON Structure containing the status codeUne structure JSON contenant le contact importé.

Field

Champ	Type
Data
status	Integer	The return code (also provided by the http status code).

Lock a Dialler Contact by ID

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

DiallerContactsIDURLIntegerThe ID of the dialler contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Lock a Dialler Contact by UserData

This function locks a dialler contact by UserData.

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

userDataQueryStringThe userData of the contact to lock.

	Données
enregistrements	DiallerContactsHistory[]	Un tableau d'historique des contacts du composeur.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http).

Exemple:

Translations Ignore

Code Block

{ "records": [ { "bOutbound": true, "dtCallEnd": "2020-11-11T15:31:47.070", "UserData": "Contact10", "ServiceNumbersID": 99, "DiallerCampaignsID": 551, "ANumber_CountryCodesID": 49, "BNumber_CountryCodesID": 49, "DiallerContactsID": 215220, "ANumber_AreaCodesID": 4645, "CONNRES": 1, "BNumber_AreaCodesID": 4645, "bCallerHangup": true, "ANumber": "49894614950703", "dtCallConnect": "2020-11-11T15:31:44.117", "dtCreatedDiallerContactsHistory": "2020-11-11T15:32:07.050", "CauseCodesID": 31, "dtCallAlert": "2020-11-11T15:31:43.190", "PhoneNumberOffset": 1, "DiallerCampaignsResultCodesID": 2811, "StatisticsPartAID": 223402, "UsersID": 3, "BNumber": "49894614950665", "UserData2": null, "ClientsID": 1, "UserData3": null, "dtCallStart": "2020-11-11T15:31:41.649", "bTestCall": false, "PhoneNumber": "49894614950703", "DiallerContactsHistoryID": 1136, "DiallerResultCodesTypesID": 3 } ], "count": 1, "status": 200 }

Récupérer l'historique des contacts du composeur par UserData

Cette fonction récupère tout l'historique (appels et codes de résultats enregistrés) pour tous les contacts du composeur avec une valeur particulière du champ UserData.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Unlock a Dialler Contact by ID

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

DiallerContactsIDURLIntegerThe ID of the dialler contact to lock.

Responses

If the request is performed, 200 OK is returned.

If the contact does not exist, 404 Not Found is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the status code.

Field

Type

Data

statusIntegerThe return code (also provided by the http status code).

Unlock a Dialler Contact by UserData

This function unlocks a dialler contact by UserData.

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
PATCHGET {baseURL}/dialler/contacts/contact/unlockhistory?userData={userData}

Parameters

Paramètres

ParameterWhereDataQuery

Paramètre
Où	Type
Données
userData	Requête	String	The userData of the contact to lock.

Responses

Chaîne de caractères

UserData des contacts du composeur à rechercher.

Réponses

Si la demande est exécutéeIf the request is performed, 200 OK is returnedest renvoyé.

If the contact does not existSi le contact source n'existe pas, 404 Not Found is returnedest renvoyé.

See Return Voir Codes for further possible status codes.

Returned Data

de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

A JSON Structure containing the status codeUne structure JSON contenant le contact importé.

FieldThe return code (also provided by the http status code

Champ	Type
Data
Données
enregistrements	DiallerContactsHistory[]	Un tableau d'historique des contacts du composeur.
compter	Entier	Le nombre d'enregistrements retournés.
statut	Entier	Le code de retour (également fourni par le code de statut http	status	Integer	).

Page tree

Page History

Versions Compared

Old Version 10

New Version Current

Key

Retrieve

Dialler Contacts

URL

Parameters

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific Dialler Contact by ID

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve Dialler Contacts by User Data

URL

Parameters

Responses

Returned Data (200 OK)

Example

Import a Dialler Contact

URL

Parameters

Post Data

Post Data

Responses

Returned Data (200 OK)

Example

Update a Dialler

Contact

URL

Parameters

Responses

Returned Data (200 OK)

Delete a Dialler Contact by UserData

URL

Parameters

Responses

Returned Data (200 OK)

Lock a Dialler Contact by ID

URL

Parameters

Responses

Returned Data (200 OK)

Lock a Dialler Contact by UserData

URL

Parameters

Responses

Returned Data (200 OK)

Unlock a Dialler Contact by ID

URL

Parameters

Responses

Returned Data (200 OK)

Unlock a Dialler Contact by UserData

URL

Parameters

Responses

Returned Data (200 OK)

Post Data

Responses

Returned Data (200 OK)

Example

Retrieve all Dialler Contacts

URL

Parameters

Responses

Returned Data (200 OK)

Example

Retrieve a specific Dialler Contact by ID

Delete a Dialler Contact by ID

URL

Parameters

Responses