Skip to main content
Skip table of contents

taskRequest

Event NametaskRequest
Event DescriptionEvent is triggered on a new conversation request.
EmitterAgent Manager


NameDescriptionPayload Properties

channelSession

type: Object

desc: contains values of properties related to the session that has been established through a particular channel e.g. web.


ccUser

type: Object

desc: This object contains agent information

Properties are described here.

taskId

type: String

desc: ID of the task i.e. chat/call request

-

conversationId

type: String

desc: ID of the conversation

-
CODE
{
   "channelSession": {
        "participantType": "ChannelSession",
        "id": "139f94dc-75ef-40da-8778-e405155da86e",
        "channel": {
            "id": "6224aa535bd05f57c1c18517",
            "name": "web",
            "serviceIdentifier": "1111",
            "tenant": {
                "id": "1f38c564-c431-44fa-8745-167a75546958",
                "name": null
            },
            "channelConfig": {
                "id": "67c47e8d-3a52-48c3-b3fd-ecbd13ff25ad",
                "channelMode": "HYBRID",
                "conversationBot": "",
                "responseSla": 60000,
                "customerActivityTimeout": 30000,
                "customerIdentificationCriteria": {
                    "value": null
                },
                "routingPolicy": {
                    "agentSelectionPolicy": "LONGEST_AVAILABLE",
                    "routeToLastAgent": true,
                    "routingMode": "PUSH",
                    "routingObjectId": "6223b4a3ef484b28639e9ca5",
                    "agentRequestTtl": 60000
                },
                "botId": "8bce469d-91d9-43a1-bf14-1f0832396588"
            },
            "channelConnector": {
                "id": "6224a9d25bd05f57c1c18506",
                "name": "web",
                "channelProviderInterface": {
                    "id": "6224a9c75bd05f57c1c18500",
                    "name": "web",
                    "supportedChannelTypes": [
                        {
                            "id": "622222cc5bd05f57c1c18421",
                            "name": "WEB",
                            "channelLogo": "_WEB.svg",
                            "isInteractive": true,
                            "mediaRoutingDomain": "6223b491ef484b28639e9ca4"
                        },
                        {
                            "id": "6233de0e3ef6175890847d4c",
                            "name": "web",
                            "channelLogo": "32917_web-1873373_1280.png",
                            "isInteractive": true,
                            "mediaRoutingDomain": "6233dde8c004592808ad3c0d"
                        }
                    ],
                    "providerWebhook": "https://cim.expertflow.com/web-channel-manager/message/receive",
                    "channelProviderConfigSchema": []
                },
                "channelProviderConfigs": [],
                "tenant": {
                    "id": "123308f8-e662-418b-abc1-1b2f8873cb26",
                    "name": null
                }
            },
            "channelType": {
                "id": "622222cc5bd05f57c1c18421",
                "name": "WEB",
                "channelLogo": "_WEB.svg",
                "isInteractive": true,
                "mediaRoutingDomain": "6223b491ef484b28639e9ca4"
            }
        },
        "customer": {
            "_id": "626ef6b8b5ccce3610e1f41f",
            "firstName": "Jane Doe",
            "phoneNumber": [],
            "isAnonymous": true,
            "__v": 0,
            "web": [
                "1133777"
            ]
        },
        "customerSuggestions": [],
        "channelData": {
            "channelCustomerIdentifier": "1133777",
            "serviceIdentifier": "1111",
            "requestPriority": 0,
            "channelTypeCode": "webChannel",
            "additionalAttributes": [
                {
                    "key": "WebChannelData",
                    "type": "WebChannelData",
                    "value": {
                        "browserDeviceInfo": {
                            "browserId": "123456",
                            "browserIdExpiryTime": "9999",
                            "browserName": "chrome",
                            "deviceType": "desktop"
                        },
                        "queue": "",
                        "locale": {
                            "timezone": "asia/karachi",
                            "language": "english",
                            "country": "pakistan"
                        },
                        "formData": {
                            "id": 0.13906573963476343,
                            "formId": 0.7384842703137151,
                            "filledBy": "web-init",
                            "attributes": [
                                {
                                    "value": "",
                                    "key": "firstName",
                                    "type": "string"
                                },
                                {
                                    "value": "",
                                    "key": "lastName",
                                    "type": "string"
                                },
                                {
                                    "value": "",
                                    "key": "email",
                                    "type": "string"
                                },
                                {
                                    "value": "1133777",
                                    "key": "channelIdentifier1",
                                    "type": "string"
                                }
                            ],
                            "createdOn": "2022-05-07T15:07:06.738Z"
                        }
                    }
                }
            ]
        },
        "latestIntent": null,
        "customerPresence": {
            "value": null
        },
        "isActive": true,
        "topicId": "cc76c196-912d-4a47-a9dd-8a2357f54399",
        "state": "STARTED",
        "active": true
    },
    "ccUser": {
        "participantType": "CCUser",
        "id": "371fa125-89ee-4197-aa6f-3e0f00bcfc3b",
        "keycloakUser": {
            "id": "371fa125-89ee-4197-aa6f-3e0f00bcfc3b",
            "firstName": "raza",
            "lastName": "",
            "roles": [
                "agent"
            ],
            "username": "raza",
            "permittedResources": null,
            "realm": "university"
        },
        "associatedRoutingAttributes": [
            {
                "routingAttribute": {
                    "id": "622b4728b3b44a59a4a49f92",
                    "name": "English",
                    "description": "Desc",
                    "type": "PROFICIENCY_LEVEL",
                    "defaultValue": 5
                },
                "value": 5
            },
            {
                "routingAttribute": {
                    "id": "6223b4c2ef484b28639e9ca6",
                    "name": "science",
                    "description": "Boolean",
                    "type": "BOOLEAN",
                    "defaultValue": 1
                },
                "value": 1
            }
        ]
    },
    "conversationId": "cc76c196-912d-4a47-a9dd-8a2357f54399",
    "taskId": "2b55db94-a506-487b-a24d-5bfff7542f59"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.