AttachUserData

This operation is part of the Chat API section of the Web Services API.

Overview

This attaches the specified UserData to a chat message.

Request URL	/api/v2/me/chats/{id}
HTTP Method	POST
Required Features	api-multimedia

Parameters

Parameter	Value
operationName	AttachUserData
userData	The data to attach

Sample

Request

POST api/v2/me/chats/0071023821aec011
{
  "operationName": "AttachUserData",
  "userData": {
      "UserData1":"DATA1",
      "UserData2":123456789  
   }
}

Response

{
  "statusCode": 0
}

Notification

{
   "referenceId": 83,
   "chat": {
       "userData": {
           "IdentifyCreateContact": "3",
           "RTargetTypeSelected": "2",
           "RTargetObjectSelected": "Chat distribution for processing",
           "RVQID": "",
           "ChatServerAppName": "es_chat",
           "PegAGChat distribution for processing": 1,
           "ChatServerHost": "htcc-ubuntu.emea.int.genesyslab.com",
           "RTargetObjSelDBID": "115",
           "ChatServerPort": "7160",
           "CBR-Interaction_cost": "",
           "CBR-contract_DBIDs": "",
           "RTargetAgentSelected": "12345",
           "CBR-IT-path_DBIDs": "",
           "RTargetRuleSelected": "",
           "UserData2": 123456789,
           "RTargetPlaceSelected": "a1",
           "CBR-actual_volume": "",
           "UserData1": "DATA1",
           "RTenant": "Environment",
           "ChatServerDBID": "115",
           "RRequestedSkills": None,
           "RRequestedSkillCombination": "",
           "RVQDBID": "",
           "RStrategyDBID": "776",
           "CustomerSegment": "default",
           "ServiceType": "default",
           "ServiceObjective": 0,
           "DISP_KEY": "resolved",
           "RTargetRequested": "Chat distribution for processing",
           "RTargetAgentGroup": "Chat distribution for processing",
           "RStrategyName": "SimpleChatInStrategy",
           "Subject": "Customer support"
       },
       "state": "Chatting",
       "capabilities": [
           "Transfer",
           "Leave",
           "Invite",
           "Consult",
           "SetInFocus",
           "SetDisposition",
           "AttachUserData",
           "DeleteUserData",
           "UpdateUserData",
           "Complete",
           "SendMessage",
           "SendStartTypingNotification",
           "SendStopTypingNotification"
       ],
       "uri": "http://localhost:8080/api/v2/chats/0000Wa9CAM6W00J",
       "participants": [
           {
               "nickname": "test_consult_clientL",
               "type": "Customer",
               "participantId": "007352CE982D031B"
           },
           {
               "nickname": "TestName",
               "type": "Agent",
               "participantId": "007352CE984F0321"
           }
       ],
       "id": "0000Wa9CAM6W00J"
   },
   "notificationType": "PropertiesUpdated",
   "messageType": "ChatStateChangeMessage"
}