SysPostChatMessage

tip

This method is available in Cloud Code scripts only.

Sends a potentially richer member chat message. By convention, content should contain a field named text for plain-text content. From is a json containing the message originator info - in this case normally "name" and potentially a "pic" url. Returns the id of the message created.

Service	Operation
chat	SYS_POST_CHAT_MESSAGE

Method Parameters

Parameter	Description
channelId	The chat channel to post to
contentJson	The json content of the message
recordInHistory	Set to false if the message shouldn't be recorded to history. Useful for sending non-conversational messages, like when users join a room, etc.
fromJson	the from information for message. Should not include id.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// N/A

GDScript

N/A

Cloud Code

var chatProxy = bridge.getChatServiceProxy();

var content = {};
content.text = "Hellooooo!";

var from = {};
from.name = "The Overseer";
from.pic = "https://myprofilepic.com?id=555"

var postResult = chatProxy.sysPostChatMessage( channelId, content, true, from );
if (postResult.status == 200 ) {
    // Success!
}

Raw

{
    "service": "chat",
    "operation": "SYS_POST_CHAT_MESSAGE",
    "data": {
        "channelId": "55555:gl:bcDev",
        "content": {
            "text": "Hello world",
            "custom": {
                "somethingCustom": "wow"
            }
        },
        "recordInHistory": true,
        "from": {
            "name": "Homer",
            "pic": "http://www.simpsons.test/homer.jpg"
        }
    }
}

JSON Response

{
    "data": {
        "msgId": "783347769003570"
    },
    "status": 200
}

Common Error Code

Status Codes

Code	Name	Description
40601	RTT_NOT_ENABLED	RTT must be enabled for this feature
40603	CHAT_UNRECOGNIZED_CHANNEL	The specified channel is invalid
40616	CLOUD_CODE_ONLY	Method only available via cloud code