IVR Aggregated Activites API Guide

IVR_AGGREGATED_ACTIVITY

{
    "id": "<messageId>", // required
    "header": {
        "channelData": {
            "channelCustomerIdentifier": "<customer-number>", // required
            "serviceIdentifier": "1218", // required and a voice channel must exists in unified-admin for this service identifier
            "additionalAttributes": [ // Call variables
                {
                    "key": "callVariable1",
                    "type": "String2000",
                    "value": "42225"
                },
                {
                    "key": "callVariable2",
                    "type": "String2000",
                    "value": ""
                }
            ]
        },
        "language": {},
        "timestamp": 1680692114700, // required
        "securityInfo": {},
        "stamps": [],
        "intent": "IVR_AGGREGATED_ACTIVITY", // required and must pass same value in request
        "entities": {},
        "sender": { // required
            "id": "f1370ff7-43fa-496e-9966-e64061d35f5c",  // required
            "senderName": "MY-IVR", // required 
            "type": "IVR", // required
            "additionalDetail": {}
        }
    },
    "body": {
        "type": "IVR_AGGREGATED_ACTIVITY", required and must pass same value in request
        "callId": "1234",  // the id of finesse/CX-voice call id
        "leg": "",         
        "startDirection": "INBOUND", //required 
        "endDirection": "DIALOG_ENDED | TRANSFER", // Set DIALOG_ENDED if call is dropped on IVR or TRANSFER if call is transferred to an agent
        "startTime": 1680692114700, // unix timestamp (long)
        "endTime": 1680692114700, // unix timestamp (long)       
        "activities": [{             // IVR menus customer has visited during this call.
            "menu": "Main",
            "selection": "Billing",
            "timestamp": "1680692114700",
            "metadata": {}
        }],
        "additionalAttr1": {},
        "additionalAttr2": {}
    }
}