Versions Compared

Old Version 19

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'fr'
Sv translation
languageen

Table of Contents
maxLevel1

Retrieve 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?diallerCampaignsID={diallerCampaignsID}


Parameters

Parameter

Where

Type

Data

diallerCampaignsIDQueryInteger

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:

FieldTypeData
filterStringThe 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
languagejs
{
    "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

ParameterWhereTypeData
diallerContactsIDURLIntegerThe 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.

FieldTypeData
recordsDiallerContacts []An array of dialler contacts, containing one contact.
countInteger1
statusIntegerThe return code (also provided by the http status code).

Example

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

Translations Ignore


Code Block
languagejs
{
    "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

ParameterWhereTypeData
userDataQueryStringThe 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.

FieldTypeData
recordsDiallerContacts[]An array of dialler contacts.
countIntegerThe number of records returned.
statusIntegerThe return code (also provided by the http status code).

Example

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

Translations Ignore


Code Block
languagejs
{
    "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

ParameterFrom ReleaseWhereTypeData
overwriteDuplicates
QueryBoolean

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.countIntegerThe number of records returned.statusIntegerThe return code (also provided by the http status code).

Example

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

Translations Ignore
Code Block
languagejs
{
    "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
}

Update a Dialler Contact 

This function 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
POST {baseURL}/dialler/contacts/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.

FieldTypeDatarecordsDiallerContacts[]An array containing the updated contact.countIntegerThe number of records returned (will always be 1).statusIntegerThe return code (also provided by the http status code).

Example

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

Translations Ignore
Code Block
languagejs
{
    "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
}

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

diallerContactsIDURLIntegerThe 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 status code.

Field

Type

Data

statusIntegerThe return 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.

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

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

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

Parameters

Parameter

Where

Type

Data

diallerContactsIDURLIntegerThe ID of the dialler 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

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

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

Parameters

Parameter

Where

Type

Data

userDataQueryStringThe 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

statusIntegerThe 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

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

FieldTypeDatarecordsDiallerContactsHistory[]An array of dialler contacts history.countIntegerThe number of records returned.statusIntegerThe 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

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

FieldTypeDatarecordsDiallerContactsHistory[]An array of dialler contacts history.countIntegerThe number of records returned.statusIntegerThe return code (also provided by the http status code).
Sv translation
languagede

Status
colourRed
titleThis page is only available in English

resetContact

Status
colourBlue
title3.39

QueryBoolean

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
colourBlue
title3.39

QueryBoolean

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

Sv translation
languagefr

Table of Contents
maxLevel1

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

DiallerCampaignsIDRequêteEntier

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

Données retournées (200 OK)

Une structure JSON contenant les champs suivants :

ChampTypeDonnéesfiltreChaîne de caractèresLe filtre appliqué. Il est réservé à un usage futur.limitStartEntierLe premier index des enregistrements. Actuellement 0, réservé pour une utilisation future.limitPageSizeEntierLe nombre d'enregistrements. -1 indique tous les enregistrements. Réservé pour une utilisation future.enregistrementsDiallerCampaigns []Un tableau de campagnes de numérotation compterEntierLe nombre de campagnes de numérotation est revenu.orderByChaîne de caractèresLe terrain servait à trier les campagnes de numérotation. ascendantBooléenQue l'éventail des campagnes soit trié de manière ascendante ou descendante.statutEntierLe 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
languagejs
{ "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ètreOùTypeDonnéesdiallerContactsIDURLEntierL'ID du Contact Composeur

Réponses

Données retournées (200 OK)

Une structure JSON contenant le contact retourné.

ChampTypeDonnéesenregistrementsDiallerContacts []Un tableau de contacts du composeur, contenant un contact.compterEntier1statutEntierLe 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
languagejs
{ "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ètreOùTypeDonnéesUserDataRequêteChaîne de caractèresuserData des contacts du composeur à rechercher.

Réponses

Données retournées (200 OK)

Une structure JSON contenant le contact retourné.

ChampTypeDonnéesenregistrementsDiallerContacts []Un tableau des contacts du composeur.compterEntierLe nombre d'enregistrements retournés.statutEntierLe 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
languagejs
{ "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ètreOùTypeDonnéesoverwriteDuplicatesRequêteBoolé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 Example (raccourcishortened, fournir 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/" 
}

Réponses



Responses

If the request is performedSi 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.

Données retournées

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)

Une structure JSON contenant le contact importéA JSON Structure containing the imported contact.

ChampFieldTypeDonnéesData
enregistrementsrecordsDiallerContacts[]Un tableau des contacts du composeurAn array of dialler contacts.
comptercountEntierLe nombre d'enregistrements retournés.
statutEntierLe code de retour (également fourni par le code de statut http).

Exemple

IntegerThe number of records returned.
statusIntegerThe return code (also provided by the http status code).

Example

Note, the dialler contact data has been shortened for readabilityNotez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

Translations Ignore


Code Block
languagejs
{
    "records": [
        {
            "bLastResultMailbox": null,
            "bPhoneNumber3Invalid": null,
            "bPhoneNumber4Invalid": null, "Company": "Company",": 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.



Update a Dialler Contact 

This function 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
  • 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.


Post Data

A JSON structure containing the contact to update.

Note that the following fields are mandatoryNotez que les champs suivants sont obligatoires :

  • ID
  • OUOR 
  • UserData

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

The other fields may be provided or left empty.

Example (all fields which can be updated, provide 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 Example (fournir les provide UserData, mise à jour partielle seulementpartial update only):

Translations Ignore


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

Réponses



Responses

If the request is performedSi la demande est exécutée, 200 OK sont renvoyés, et le contact mis à jour est renvoyé.

Données retournées

is returned, and the updated contact is returned.

See Return Codes for further possible status codes.

Returned Data (200 OK)

Une structure JSON contenant le contact mis à jour.

A JSON Structure containing the updated contact.

FieldChampTypeDonnéesData
enregistrementsrecordsDiallerContacts[]Un tableau contenant le contact mis à jourAn array containing the updated contact.
comptercountEntierIntegerThe number of records returned (will always be Le nombre d'enregistrements retournés (sera toujours 1).
statutstatusEntierIntegerLe The return code de retour (également fourni par le code de statut http(also provided by the http status code).

Exemple

Example

Note, the dialler contact data has been shortened for readabilityNotez que les données de contact du composeur ont été raccourcies pour plus de lisibilité.

Translations Ignore


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

Supprimer un contact composeur par ID


Delete a Dialler Contact by ID

This function deletes a dialler contact including all related data by IDCette 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

diallerContactsIDURLEntierIntegerL'ID du contact du composeur à supprimer.

Réponses

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

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

Données retournées
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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

statutstatusEntierIntegerLe The return 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.

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

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 beNotez 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

UserDatauserDataRequêteQueryChaîne de caractèresL'UserData du contact du composeur à supprimer.

Réponses

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

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

Données retournées
StringThe 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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

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

Verrouillage d'un composeur par ID

(also provided by the http status code).

Lock a Dialler Contact by ID

This function locks a dialler contact by 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

diallerContactsIDURLEntierIntegerL'ID du contact du composeur à verrouiller.

Réponses

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

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

Données retournées
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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

statutstatusEntierIntegerLe The return 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.

(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 beNotez 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

UserDatauserDataRequêteQueryChaîne de caractèresStringThe userData du contact à verrouillerof the contact to lock.

Réponses

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

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

Données retournées

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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

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

Déverrouiller un contact composeur par ID

(also provided by the http status code).

Unlock a Dialler Contact by ID

This function unlocks a dialler contact by Cette fonction déverrouille un contact du composeur par ID.

URL

Translations Ignore


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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

diallerContactsIDURLEntierIntegerL'ID du contact du composeur à verrouiller.

Réponses

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

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

Données retournées
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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

statutstatusEntierIntegerLe The return 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.

(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 beNotez 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

UserDatauserDataRequêteQueryChaîne de caractèresStringThe userData du contact à verrouillerof the contact to lock.

Réponses

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

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

Données retournées

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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

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

Réinitialisation d'un contact Composeur par ID

(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 diallerCette 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



Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

diallerContactsIDURLEntierIntegerL'ID du contact du composeur à réinitialiser.

Réponses

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

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

Données retournées
The ID of the dialler 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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

statutstatusEntierIntegerLe The return 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.

(also provided by the http status code).

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 beNotez 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 {baseURL}/dialler/contacts/contact/reset?userData={userData}
Paramètres


Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

UserDatauserDataRequêteQueryChaîne de caractèresL' userData du contact à réinitialiser.

Réponses

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

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

Données retournées
StringThe 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)

Une structure JSON contenant le code de statut.

A JSON Structure containing the status code.

FieldChamp

Type

DonnéesData

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

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

(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 IDCette 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 composeur.

URL

Translations Ignore


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


Parameters

 ParamètreParameter

OùWhere

Type

DonnéesData

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

Réponses

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

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

Données retournées
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)

Une structure JSON contenant le contact importéA JSON Structure containing the imported contact.

ChampFieldTypeDonnéesData
enregistrementsrecordsDiallerContactsHistory[]Un tableau d'historique des contacts du composeur.
compterEntierLe nombre d'enregistrements retournés.
statutEntierLe code de retour (également fourni par le code de statut http).
Exemple
An array of dialler contacts history.
countIntegerThe number of records returned.
statusIntegerThe 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 
}

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


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

URL

Translations Ignore


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


Parameters

 ParamètreParameterOùWhereTypeDonnéesData
UserDatauserDataRequêteQueryChaîne de caractèresStringThe userData des contacts du composeur à rechercherof the dialler contacts to search for.

Réponses

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

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

Données retournées

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)

Une structure JSON contenant le contact importéA JSON Structure containing the imported contact.

Le code de retour (également fourni par le code de statut http).
ChampFieldTypeDonnéesData
enregistrementsrecordsDiallerContactsHistory[]Un tableau d'historique des contacts du composeur.
compterEntierLe nombre d'enregistrements retournés.
statutEntier
An array of dialler contacts history.
countIntegerThe number of records returned.
statusIntegerThe return code (also provided by the http status code).


Sv translation
languagede

Status
colourRed
titleThis page is only available in English