Rate this page:

User

Interface that represents a Voximplant user with Messaging user id. Voximplant users are created in Voximplant control panel or via HTTP API. To get user(s) information use the Messenger.getUser Messenger.getUsers Messenger.getUserByIdand Messenger.getUsersByIdmethods.

Props

conversationsList

Copy URL
conversationsList: 

string[]

|

undefined

Array of conversation UUIDs the current user belongs to. Not available for all other users (undefined).

customData

Copy URL
customData: 

object

Public custom data available to all users. Can be set via Messenger.editUser

displayName

Copy URL
displayName: 

string

The user's display name specified in Voximplant control panel or via HTTP API.

notificationEvents

Copy URL
notificationEvents: 

MessengerEvents[]

|

undefined

Array of MessengerEventsthe current user is subscribed to (when they occur, the user receives push notifications). Not available for all other users (undefined). The current user subscriptions can be set via the Messenger.manageNotificationmethod.

privateCustomData

Copy URL
privateCustomData: 

any

|

undefined

Private custom data available only to the current user. Undefined for all other users.

userId

Copy URL
userId: 

number

Messaging user id. It's used to identify users only within the Messaging module.

userName

Copy URL
userName: 

string

The Voximplant user identifier (e.g. 'username@appname.accname').