This object represents a nandbox user or bot account.
Field | Type | Required | Description |
---|---|---|---|
id |
String | Conditional | Unique identifier for this User or API(Bot). Not required in User object in the setWhitelistUsers or setBlackListUsers methods. |
signup_id |
String | Conditional | A unique identifier for the user, based on the app's configuration: Email if email-based signup, mobile number if mobile-based signup, or a unique ID if no login is required. This field is required for Signup: User Management messages |
name |
String | Yes | User or bot name. |
version |
String | Yes | Last updated user profile version. |
terminal |
String | Optional | Mobile if sent from a mobile device or API if sent from an API. Only returned if the user object is inside an incoming Message. |
type |
String | Optional | Contact if sent from a normal user, and Bot if sent from a bot. Only returned if the user object is inside an incoming Message. |
is_bot |
Boolean | Optional | True if this user is a bot. Returned only in getUser. |
status |
String | Optional | User status. Returned only in getUser. |
photo |
Photo | Optional | Public user's photo (media type). Returned only in getUser. |
profile |
String | Optional | Profile type: "Other" , "Friend" , "Work" , or "Family" . |
{
"user": {
"image": "\\/9j\\/4AAQSkZJRgABAQAAAQABAAD\\/2wBDABsSFBcUERsXFhceHBsgKEIrKCUlKFE6PTBCYFVlZF9V\\nXVtqeJmBanGQc1tdhbWGkJ6jq62rZ4C8ybqmx5moq6T\\/2wBDARweHigjKE4rK06kbl1upKSkpKSk\\npKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKT\\/wAARCABpAGkDASIA\\nAhEBAxEB\\/8QAGQAAAwEBAQAAAAAAAAAAAAAAAgMEBQEA\\/8QANBAAAgIBAwIEAwYFBQAAAAAAAQIA\\nAxEEITESQSJRYXETFIEFMjNSkaEjJDRysTVCYpLR\\/8QAGAEBAQEBAQAAAAAAAAAAAAAAAgEAAwT\\/\\nxAAdEQEBAQEAAgMBAAAAAAAAAAAAARECEjEDIUFR\\/9oADAMBAAIRAxEAPwCnuYi2+tNhuYWqYrUc\\ncnaZh6snbM48z9dqpa+wnYDE91ty3HrJlsIGCM+kMEN6enadBUqosGFYZ8oLK42KmK8SnIl9bGyo\\nE8jvFOqliF1PkYvBzxLjAMWhieDKSBEWDxfWc7DlPTvKK+JPX3lNfEc9BfZWt\\/A+omdtNHUrZYOh\\nVyvnJvlLPy\\/vOk6kTxtWarHwxmQ7SzW\\/hD3kgX0+s83Pp2rgUeUalWCDDrqxuYWQp3MrKNPpksHi\\ng69Pk9IGrO\\/Vg5jNPdWD0538sRP2zaraPpDZPUJY1Z665icOB7iPVw4yrAiZTbTqWsh6lMTm1cmK\\nsBzmcou+KmcbjmO+E7jKiaxpaKvvKK+IpanHIjkBAwZYlEFJ4BPtPdJ8jHVjwrkDmHkeQ\\/SbWxDq\\n16qGx23kqkNhwRtyJoYzJKqDVbZ3U8ThzXamg7T1dCWthp3IgLb0sW5AjZ41JRql6ePKSfaKCu7o\\nBJGOrc95RWBfaXLkb5kGuuFuodgcrnAPoIoNTsIPTCG5Al2mpU0MWUHeUYn0Jw7L5iaI6yB0nG0S\\nlSV\\/dUCUJz9Jak9p7NRbW\\/SRv7wPm38v3nbgTqWxjjvPCtz+X9JMbWppmJorJ7rmNyYuoYrQeSiM\\nmUsCJPJlIRsZ3GfOC1RYcKwg5+P9K95We1pUnuJxXDHY7HmVNpVJ3Vl\\/cT1mmGn01jICWxsRF42J\\n5SotVctNHQhw7nB37TMYzZ1f2dZqFS1ehLCPECefWQP9l6oDIQN\\/awlwbU9JzYAZqacH4BwM53mZ\\nTWwswQR2M19M9agL1jPkZKUKzGqf8QdSFFmV4InU4HtLRzKi1R\\/mG+kWCSRC1RxqGg1DqsUeZE0Z\\nvLtt5ACFAB8RhZlY7rY+UWwUnqCjPfbeHBLYYH9Y4ALKrlwarMg\\/7X3\\/AHhI9qKPiBR4sHHaGXDd\\nJHEF8MXU8ESo4KmQkDLKTkf8T\\/5PWIUrLA8HM7VZlME5I2PrGHDoV8xiZkL0pazEDx4zt3Ekt03i\\nVg2MS+vCHqOxCkRep07Ei1e43ENhSpNQ2Co9IyvdQfSIZC5xyRKaqQ1akkjbicz9\\/aDVIxvJCkic\\n0qP8zXlTjqE0\\/l1\\/MZ1KArg5OxmY5RyfWHODidiQefSJssGM9vPiMsOQF7E7yUOtjFuR29orcSTT\\nK7BsM8RnX\\/FT1k7V+UFSyuCcnEk7W8fw8nosz5bH2jwcbiSvYrHIjFfw88RaGO34VHftOUXCzYmJ\\ne8FSB0nfcGJNyjxJsfKTyLxN1FHQ5deDz6TivlfC2MQ67www0VqakC5DBQfOGxoLrf8AOP0hVOzW\\nYJB+kzQy1ucP1Z2lehI6ue0Br14E7BGw84UYkam8DTNYp5Xw+5mbp9QawFbcdo0\\/6VX7j\\/MjMWSw\\ndxopqeoZ3xGrcp7iZ1X3RCE53l0nWtDKGASC3Qm7YzzxJRxD039Sf7JJFteOnOfGWHtGfKZ4fH0l\\nBnRxHPoKmGnur32YehnEsF3Uj4CkdzKbPvp7GZVf4495dRQdHpc5wP8AsYwLUg8JH6z0B+JMjSjp\\n1I8Sk7A7GO+MPzCZlPDe8bMr\\/9k=\\n",
"name": "Henry Bell",
"photo": {
"thumbnail": {
"width": 120,
"id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg.thumb.jpg",
"height": 256
},
"width": 120,
"id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg",
"height": 256
},
"id": "90089584980037358",
"is_bot": false,
"version": "00KH",
"status": "click for help"
}
}