Overview

1. Result

{
    "resultCode": "success",
    "result": {
        "pageNo": 1,
        "inPage": 15,
        "perPage": 15,
        "total": 82,
        "data": [
            {
                "leadId": 12979,
                "timezone": "Australia/Sydney",
                "isComplete": 1,
                "customerKey": "A2098",
                "phone1": "+6128XXXXXXX",
                "phone2": "+6128XXXXXXX",
                "phone3": "+6128XXXXXXX",
                "leadUploadDate": "2018-09-05 11:00:47",
                "lastDiallerTimestamp": "2019-05-22 12:11:00",
                "scheduledCallTimestamp": null,
                "campaignId": 1315,
                "listId": 315,
                "isDialling": 0,
                "leadData": "{\"CompanyName\":\"Ram20\",\"AccountID\":null,\"Address\":\"VIC\",\"Priority\":null,\"QBDKeyContactEmail\":null,\"QBDKeyContact\":null,\"SFLeadId\":null,\"RegistryID\":null,\"ProductID\":null,\"QBRNumber\":null,\"ABN\":\"42\",\"StoredTravellers\":null}",
                "dialAttempts": 2,
                "diallerOutcomes": [
                    {
                        "dialStatus": "Disconnected",
                        "dialTimestamp": "2019-02-15 11:35:18",
                        "answeredTimestamp": null,
                        "hangupTimestamp": "2019-02-15 11:35:25"
                    },
                    {
                        "dialStatus": "Answered",
                        "dialTimestamp": "2019-05-22 12:11:00",
                        "answeredTimestamp": "2019-05-22 12:11:05",
                        "hangupTimestamp": "2019-05-22 12:14:46"
                    }
                ]
            },
...
           
CODE

2. Parameters

Parameter

Required

Description

Data Type

agentId

 

The unique system identifier for each individual agent. E.g. 1221.

Numeric

campaignId

Yes

The unique system identifier for each individual campaign. E.g. 1234.

Numeric

campaignTitle

 

The title assigned to the campaign.

String

customerKey

 

The unique identifier for each lead in a list. The lead customer key can repeat amongst different lists.

String

fromTimestamp

 

The date and time when the activity was created. E.g. YYYY-MM-DD hh:mm 

Timestamp

leadStatus

 

The completeness status of the lead. E.g. 'COMPLETE', 'INCOMPLETE', 'ALL'.

String

leadType

 

The type of the lead. E.g. 'New', 'Call Back - Queue', 'Call Back - Agent'. 

String

listId

 

The unique system identifier for each individual lead list. E.g. 1234. 

Numeric

listTitle

 

The list title. 

String

loadedDateFrom

 

The date the lead was loaded. Enter a valid date/time format (e.g. yyyy-mm-dd hh:mm:ss), e.g. 2003-6-4 8:8:9, 2003-06-04 08:08:09, 4/6/2003 8:8:9, 04/06/2003 08:08:09. 

Timestamp

loadedDateTo

 

The date the lead was loaded. Enter a valid date/time format (e.g. yyyy-mm-dd hh:mm:ss), e.g. 2003-6-4 8:8:9, 2003-06-04 08:08:09, 4/6/2003 8:8:9, 04/06/2003 08:08:09. 

Timestamp

pageNo

 

The page number. Starting from 1, default=1, min=1. 

Numeric

perPage

 

The page size. Default=15, min=1, max=100. 

Numeric

phoneNumber

 

Any of the Phone Numbers for the lead, valid phone number, e.g. (02)84930293, +61473829344, 1300493829, 83748392.

Numeric

sortField

 

The field used to sort the leads list. Select one of 'campaignId', 'campaignTitle', 'listId', 'listTitle', 'leadType', 'leadStatus', 'agentId', 'timezone', 'customerKey', 'phoneNumber', 'callback'.

String

sortOrder

 

The sort order for the list. Select from ASC or DESC.

String

timezone

 

The timezone defined for the lead, e.g. Australia/Sydney.

String

toTimestamp

 

The date and time when the activity was terminated. E.g. YYYY-MM-DD hh:mm 

Timestamp