Skip to main content
Skip table of contents

Channel Session Update Data API

The properties of the Channel Session Update Data API is described below:

PUT/forms

The body should be in JSON format and include the following properties:

Request

ParameterDescriptionTypeProperties

channelSessionId  REQUIRED 

Path variable

String

-

body REQUIRED

The request body is basically a list of Attribute class. The example for attribute class is given in the property section

List

Example: 

[
        {
            "key": "info",
            "type": "AlphanumSpecial200",
            "value":{
                "browserDeviceInfo": {
                     "browserId""123456",
                     "browserIdExpiryTime""9999",
                     "browserName""chrome",
                     "deviceType""desktop"
                    }            }
        },
         {
                "key""name",
                "type""String2000",
                "value""Haroon Ahmed1"
        }
]

CodeDescription

200

Code 200 implies that the channel session data  has been updated.

CODE
{
    "participantType": "ChannelSession",
    "id": "64e2f08a6155b317cd3f88fd",
    "participantType": "ChannelSession",
    "channel": {
        "id": "64c90b8d6d35790df2ef7197",
        "name": "Web Push",
        "serviceIdentifier": "1222",
        "defaultOutbound": false,
        "tenant": {
            "id": "64df42ad8ebf303a2bca5d21",
            "name": null
        }, 
		"channelConfig": {
            "id": "64df42ad8ebf303a2bca5d22",
            "channelMode": "HYBRID",
            "conversationBot": "",
            "responseSla": 0,
            "customerActivityTimeout": 180,
            "customerIdentificationCriteria": {
                "value": null
            },
            "routingPolicy": {
                "agentSelectionPolicy": "LONGEST_AVAILABLE",
                "routeToLastAgent": true,
                "routingMode": "PUSH",
                "routingObjectId": "64c90af1eb1d14361be733cf",
                "agentRequestTtl": 180
            },
            "botId": "64c90827b7f4c91fef444f87"
        },
        "channelConnector": {
            "id": "64c90a566d35790df2ef713b",
            "name": "Web Connector",
            "channelProviderInterface": {
                "id": "64c90a3e6d35790df2ef7128",
                "name": "Web Provider",
                "supportedChannelTypes": [
                    {
                        "id": "64c906056d35790df2ef70f2",
                        "name": "WEB",
                        "channelLogo": "_WEB.svg",
                        "isInteractive": true,
                        "mediaRoutingDomain": "6305de07166ba1099d11d8e6"
                    }
                ],
                "providerWebhook": "https://cim-dev.expertflow.com/web-channel-manager",
                "channelProviderConfigSchema": []
            },
            "channelProviderConfigs": [],
            "tenant": {
                "id": "64c90f196d35790df2ef8634",
                "name": null
            }
        },
        "channelType": {
            "id": "64c906056d35790df2ef70f2",
            "name": "WEB",
            "channelLogo": "_WEB.svg",
            "isInteractive": true,
            "mediaRoutingDomain": "6305de07166ba1099d11d8e6"
        }
    },
    "customer": {
        "_id": "64df47adc20d6dc56f2f0ac7",
        "firstName": "Jane Doe",
        "phoneNumber": [],
        "isAnonymous": true,
        "__v": 0,
        "web": [
            "92306653154"
        ]
    },
    "customerSuggestions": [],
    "channelData": {
        "channelCustomerIdentifier": "92306653154",
        "serviceIdentifier": "1222",
        "requestPriority": 0,
        "additionalAttributes": [
            {
                "key": "name",
                "type": "String2000",
                "value": "Haroon Ahmed1"
            },
            {
                "key": "info",
                "type": "AlphanumSpecial200",
                "value": {
                    "browserDeviceInfo": {
                        "browserId": "123456",
                        "browserIdExpiryTime": "9999",
                        "browserName": "chrome",
                        "deviceType": "desktop"
                    }
                }
            },
            {
                "key": "name",
                "type": "String2000",
                "value": "Haroon Ahmed1"
            }
        ]
    },
    "latestIntent": null,
    "customerPresence": {
        "value": null
    },
    "isActive": true,
    "conversationId": "64e2f08fa75bb24a09444834",
    "state": {
        "name": "STARTED",
        "reasonCode": "CUSTOMER"
    },
    "channelSessionDirection": "INBOUND",
    "active": true
}


Quick Links

Channel Session Update  API Postman Collection

JavaScript errors detected

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

If this problem persists, please contact our support.