Overview

1. Result

{
    "resultCode": "success",
    "result": {
        "pageNo": 1,
        "inPage": 15,
        "perPage": 15,
        "previousPage": null,
        "nextPage": "http://yourinstance.ipscape.com.au/api/latest/campaign/readcallslist?pageNo=2&",
        "data": [
            {
                "activityId": 20688,
                "parentActivityId": null,
                "interactionId": 19292,
                "startTimestamp": "2020-07-23 20:00:18",
                "endTimestamp": "2020-07-23 20:01:04",
                "duration": 34,
                "talkSeconds": 20,
                "campaignId": 1303,
                "campaignTitle": "AA_Outbound1",
                "wrapCode": "AA_TestPass",
                "wrapId": 168,
                "agentId": 1441,
                "agentName": "Agent AAA",
                "leadId": 119485,
                "callerNumber": "02XXXXXXXX",
                "calledNumber": "+614XXXXXXXX",
                "activityStatus": "Answered",
                "isTransferred": false,
                "isEncrypted": false,
                "isDeleted": false,
                "deletedTimestamp": null,
                "deletedBy": null,
                "deletionReason": null
            },
}
...
CODE

2. Parameters

Parameter

Required

Description

Data Type

activityId

 

The unique system identifier for the activity. E.g. 1234. 

Numeric

agentId

 

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

Numeric

callType

 

The type of the call. E.g. MANUAL CALL, INBOUND, OUTBOUND

String

calledNumber

 

The CLI (caller ID) of the called phone number. Valid phone number, e.g. (02)84930293, +61473829344, 1300493829, 83748392.

String

callerNumber

 

The CLI (caller ID) of the callers phone number. Valid phone number, e.g. (02)84930293, +61473829344, 1300493829, 83748392.

String

campaignId

 

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

Numeric

campaignTitle

 

The title assigned to the campaign.

String

fromTimestamp

 

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

Timestamp

interactionId

 

The unique system identifier for each individual agent interaction. E.g. 1234. 

Numeric

pageNo

 

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

Numeric

perPage

 

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

Numeric

sortField

 

The field used to sort the calls list. Select one of 'campaignTitle', 'fromTimestamp', 'activitySource', 'activityDestination', 'callDuration', 'description'. 

String

sortOrder

 

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

String

toTimestamp

 

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

Timestamp

wrapCode

 

The interaction wrap code name.

String