AttachUserData

This operation is part of the IM Session API section of the Web Services API.

Overview

Attaches user data to the IM session.

Request URL	/api/v2/me/im-sessions/{id}
HTTP Method	POST
Required Features	api-voice-instant-messaging

Parameters

Parameter	Value
operationName	AttachUserData
userData	The user data to attach. The data should be in the same format as all telephony user data operations. (mandatory)

Samples

Request

POST /api/v2/me/im-sessions/00446K0L8GAC3B9R8O7GK2LAES00000D
{
  "operationName": "AttachUserData",
  "userData": {
    "bestNumber": "3"
   }
}

HTTP Response

{
  "statusCode": 0
}

CometD Response

{  
   "messageType":"IMSessionStateChangeMessage",
   "notificationType":"AttachedDataChanged",
   "imSession":{  
      "state":" Talking",
      "userData":{  
         "bestNumber": "3"
      },
      "id":"12398123091823091283012",
      "uri": "http://hpe-voicevm-64.genesyslab.com:8090/api/v2/im-sessions/00S4UMMDT8AHN1VL807GK2LAES000002", 
      "path":"/im-sessions/12398123091823091283012",
      "participants": [
         {
            "digits": "3002",
            "e164Number": "3002",
            "formattedPhoneNumber": "3002",
            "phoneNumber": "3002"
         }
      ],
      "capabilities":[  
         "Complete",
         "AttachUserData",
         "DeleteUserData",
         "UpdateUserData",
         "SendMessage"
      ]
   }
}