SysPostChatMessageSimple

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_SIMPLE

Method Parameters

Parameter	Description
channelId	The chat channel to post to.
text	A simple message.
recordInHistory	Should the message be recorded in history? Using 'false' is useful for sending non-conversational messages, like when users join a room, etc.
from	Details of the user posting the message.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Objective-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var channelId = "55555:gl:bcDev";
var text = "Hello world";
var recordInHistory = true;
var from = {
  "name": "Homer",
  "pic": "http://www.simpsons.test/homer.jpg"
};
var chatProxy = bridge.getChatServiceProxy();

var postResult = chatProxy.sysPostChatMessageSimple(channelId, text, recordInHistory, from);
if (postResult.status == 200) {
    // Success!
}

Raw

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

JSON Response

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

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