ChatRoom Node

This node contains chat room definitions. These nodes are contained within a ChatRooms container node. The type of object that the chat room is attached to is indicated by the ParentType property.

Example:

Calling the API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.

The format of the call :https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50565&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&InfoTypeFilter={filter code list, in |OPTION|OPTION| format…}

Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50565. All other parameters may appear in any sequence order.

Attribute	Type	Comment
ChatRoomKey	Integer	The Notified chat room key for this chat room.
ParentType	String	Indicates the type of parent object that this document/link is attached to. Values are Show, Booth, or Event.
Name	String	The title of the chat room.
ExternalID	String	External ID for this chat room.
DisplayUserNameBar	Flag (0/1)	Flag indicating whether to display a list of users currently in the chat room.
TrackActivity	Flag (0/1)	Flag indicating whether to track user entry into this chat room.
VideoEnabled	Flag (0/1)	Flag indicating whether this chat room is a text-only or a videoconference chat.
MaxVideoUsers	Integer	If videoconference chat, this indicates how many users can have a video pod (1-9).
MaxUsers	Integer	The maximum number of users that can enter this chat room at any given time.
EnableOnlyModerators	Flag (0/1)	Flag indicating whether only chat room moderators can be assigned video pods.
MaxChatLines	Integer	The number of lines of text from prior chat history to preload when a user initially enters the chat room.