Version: 4.15.0

Chat

Overview

Chat is a new service that enables real-time communication between end-users. It is available to apps that have brainCloud RTT enabled.

This page describes the Chat Service S2S API methods. For the client api, go to Chat Service - Client API.

Chat Service - S2s API

These API calls bypass channel membership / message ownership checks - and allow you to post messages from the system (i.e. app) instead of from another end-user:

API Summary

ChatService

These API calls bypass channel membership / message ownership checks - and allow you to post messages from the system (i.e. app) instead of from another end-user:

GetChannelId - Gets the channelId for the given \<channelType> and \<channelSubId>. Channel type must be one of "gl" or "gr".
SysCreateChannel - Initializes a dynamic chat channel. Returns the channelId. Channel type must be "dy".
SysDeleteChannel - Deletes a dynamic chat channel. Channel type must be "dy". This will delete the chat history as well.
SysGetChannelInfo - Gets description info and activity stats for channel \<channelId>. Note that numMsgs and listeners only returned for non-global groups. Only callable for channels the user is a member of.
SysGetChatMessage - Gets a populated chat object (normally for editing).
SysGetRecentChatMessages - Get a list of \<maxReturn> messages from history of channel \<channelId>
SysPostChatMessage - Send a potentially rich chat message. \<recordInHistory> is optional and true by default. \<fromJson> is optional and can contain a "name" and/or "pic" entry.
SysPostChatMessageSimple - Send a simple-text message. \<recordInHistory> is optional and true by default. \<fromJson> is optional and can contain a "name" and/or "pic" entry.
SysUpdateChatMessage - Update a chat message. \<version> must match the latest or pass -1 to bypass version check.
SysDeleteChatMessage - Delete a chat message. \<version> must match the latest or pass -1 to bypass version check.