User

An object that contains information about guest

PropertyTypeDescription
idStringa user id
nameStringa user name
avatarUrlStringa user's avatar url
alertIntegera user's alert count
profileObjectan object contains key/value information
var user = {
  "id": "userId",
  "name": "userName",
  "avatarUrl": "https://channel.io/guest.png",
  "alert": 5,
  "profile": {
    "mobileNumber": "+8201012345678"
  }
};

Profile

An object that contains user specific information

PropertyTypeDescription
nameStringa user's name
emailStringa user's email address
mobileNumberStringa user's mobile number
avatarUrlStringa user's avatar url

Extra properties

Other keys and values can be included in a profile on same level of other default properties for extra information.

var profile = {
  "name": "channel",
  "mobileNumber": "+821012345678",
  "email" : "[email protected]",    
  "CUSTOM_VALUE_1": "VALUE_1",
  "CUSTOM_VALUE_2": "VALUE_2"
};