Versions Compared

Old Version 2

changes.mady.by.user jtel Support

Saved on

compared with

New Version 3

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel1

Retrieve all Dialler Contacts

This function retrieves all dialler contacts from the client account.

URL

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:

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.

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

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

Query Parameters

ParameterTypeData
DiallerContactsIDIntegerThe 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.

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

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

Query Parameters

ParameterTypeData
userDataStringThe userData of the dialler contacts to search for.

Responses

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

Returned Data (200 OK)

A JSON Structure containing the returned campaign.

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.

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
}