Overview

1. Result

{
    "resultCode": "success",
    "result": {
        "pageNo": 1,
        "inPage": 15,
        "perPage": 15,
        "previousPage": null,
        "nextPage": "http://yourinstance.ipscape.com.au/api/latest/activity/readactivitieslist?pageNo=2&",
        "data": [
            {
                "activityId": 20688,
                "parentActivityId": null,
                "campaignId": 1303,
                "campaignTitle": "AA_Outbound1",
                "leadId": 119485,
                "activitySource": "+612XXXXXXX",
                "activityStart": "2020-07-23 20:00:18",
                "activityEnd": "2020-07-23 20:01:04",
                "activityResultTimestamp": null,
                "activityAnsweredTimestamp": "2020-07-23 20:00:25",
                "queueEntryTimestamp": null,
                "activityDestination": "+614XXXXXXXX",
                "activityType": "OUTBOUND",
                "resultType": "",
                "secondsInQueue": 0,
                "callDirection": "OUT",
                "dialSeconds": 7,
                "voicerecordingId": 16207,
                "customData": "",
                "customText": "",
                "activityStatus": "Answered",
                "sourceType": "EXTERNAL",
                "isTransferred": 0,
                "talkSeconds": 36,
                "recordingSeconds": 34,
                "totalSeconds": 65,
                "agentId": 1441,
                "interactionId": 19292,
                "surveyInitiated": 0,
                "surveyWorkflowName": null,
                "surveyWorkflowTimestamp": null,
                "mediaType": "Voice"
}
]
}
}
...
CODE

2. Parameters

Parameter

Required

Description

Data Type

activityDestination

The destination phone number for a call. For example, in an outbound call, the destination may be a lead phone number. For an inbound, the destination is the workflow DNIS. Empty on chats and email activities. E.g. (02)84930293, +61473829344, 1300493829, 83748392. 

String

activityId

The unique system identifier for the activity, e.g. 1234. 

Numeric

activitySource

The source phone number for a call. For example, in an outbound call, the source can be the agent CLI, the campaign CLI or the organisation CLI. For an inbound, the source is the customer CLI. Empty on chats and email activities. E.g. (02)84930293, +61473829344, 1300493829, 83748392. 

String

activityStatus

The human-readable name of the activity status. E.g.: In queue (1), Answered (3), Voicemail (4), Abandoned (5), Diverted (8), Email Removed from Queue (9), Auto Callback (12), Cancelled (13), In Workflow (14), DID Call (15), MPQ Callback (16) 

String

activityType

The human-readable activity type. Valid values are: MANUAL CALL, INBOUND, OUTBOUND, EMAIL, CHAT.

String

agentId

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

Numeric

campaignId

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

Numeric

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. 

Timestamp

isTransferred

Boolean to indicate if an activity was transferred (0,1). If set to "1", the activity corresponds to a transfer

Boolean

mediaType

The media type of the activity, valid values are [UNKNOWN, VOICE, EMAIL, FACEBOOK, TWITTER, WEB_MESSAGES, SMS].

String

pageNo

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

Numeric

perPage

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

Numeric

sinceActivityId

When provided, this filter will return records where activityId > sinceActivityId. E.g. 1234.

Numeric

sortField

The field used to sort the activities list. Select one of 'activityId'.

String

sortOrder

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

String

sourceType

Source type, valid values are [INTERNAL, EXTERNAL, TRANSFER].

String

toTimestamp

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

Timestamp