Text Message - social.plus

Use text messages for standard chat content. All SDKs support creating text messages by subChannelId; optional fields such as tags, metadata, mentionees, and parentId are available through platform-specific payloads or builders.

Parameters

Parameter	Required	Description
`subChannelId`	Yes	Target subchannel where the text message will be created.
`text`	Yes	Plain text content for the message.
`tags`	No	App-defined tags that can be used by message queries.
`metadata`	No	App-defined JSON-style metadata stored with the message.
`mentionees` / `mentionUsers`	No	Users mentioned by the text message when the platform exposes mention builders.
`parentId`	No	Parent message ID when the text message is a reply.

Basic Text Message

Create a basic text message with a subChannelId and text body.

import { MessageRepository } from '@amityco/ts-sdk';

const { data: message } = await MessageRepository.createMessage({
  subChannelId,
  dataType: 'text',
  data: {
    text: 'Welcome to the channel',
  },
});

renderResults(message);

let options = AmityTextMessageCreateOptions(
    subChannelId: "sub-channel-id",
    text: "Welcome to the channel"
)

let message = try await messageRepository.createTextMessage(options: options)
showSuccessMessage(message.messageId)

val disposable = AmityChatClient.newMessageRepository()
    .createTextMessage(
        subChannelId = subChannelId,
        text = "Welcome to the channel",
    )
    .build()
    .send()
    .subscribe(
        { showSuccessMessage() },
        { error -> handleGeneralError(error) },
    )

final message = await AmityChatClient.newMessageRepository()
    .createMessage(subChannelId)
    .text('Welcome to the channel')
    .send();

final messageId = message.messageId;

Text With Context

Add tags, metadata, mentions, or reply context when the text message needs extra app-owned behavior.

import { MessageRepository } from '@amityco/ts-sdk';

const { data: message } = await MessageRepository.createMessage({
  subChannelId,
  dataType: 'text',
  data: {
    text: 'Please review this update',
  },
  tags: ['announcement'],
  metadata: {
    source: 'composer',
  },
  mentionees: [{ type: 'user', userIds: [userId] }],
});

let metadata: [String: Any] = [
    "source": "composer"
]

let options = AmityTextMessageCreateOptions(
    subChannelId: "sub-channel-id",
    text: "Please review this update",
    tags: ["announcement"],
    metadata: metadata
)

let message = try await messageRepository.createTextMessage(options: options)
showSuccessMessage(message.messageId)

val metadata = JsonObject().apply {
    addProperty("source", "composer")
}

val disposable = AmityChatClient.newMessageRepository()
    .createTextMessage(
        subChannelId = subChannelId,
        text = "Please review this update",
    )
    .tags(AmityTags(listOf("announcement")))
    .metadata(metadata)
    .mentionUsers(listOf(userId))
    .build()
    .send()
    .subscribe()

final message = await AmityChatClient.newMessageRepository()
    .createMessage(subChannelId)
    .text('Please review this update')
    .tags(['announcement'])
    .metadata({'source': 'composer'})
    .mentionUsers([userId])
    .send();

Reply to a Message

Create a text reply with parentId.

Query Messages

Query text messages and reply threads.

⌘I