Interface CreateCustomMessageParams

创建自定义消息的入参。

interface CreateCustomMessageParams {
    conversationId: string;
    conversationType: "singleChat" | "groupChat" | "chatRoom";
    ext?: Record<string, unknown>;
    timestamp?: number;
    receiverList?: string[];
    deliverOnlineOnly?: boolean;
    webhookEnv?: string;
    priority?: MessagePriority;
    needReadReceipt?: boolean;
    isChatThread?: boolean;
    event: string;
    params?: Record<string, string>;
}

Hierarchy (View Summary)

Properties

conversationId conversationType ext? timestamp? receiverList? deliverOnlineOnly? webhookEnv? priority? needReadReceipt? isChatThread? event params?

Properties

conversationId

conversationId: string

会话 ID：单聊时为对端用户 ID；向当前用户的指定其他设备发消息时，可传 当前用户ID/设备ID；群聊时为群组 ID，聊天室时为聊天室 ID。

conversationType

conversationType: "singleChat" | "groupChat" | "chatRoom"

会话类型。

Optionalext

ext?: Record<string, unknown>

消息扩展字段，需保持 JSON 可序列化。

Optionaltimestamp

timestamp?: number

本地时间戳，单位毫秒；不传时由 SDK 生成。

OptionalreceiverList

receiverList?: string[]

群聊或聊天室定向消息的接收者列表；单聊不支持。

OptionaldeliverOnlineOnly

deliverOnlineOnly?: boolean

是否仅投递给在线用户。

OptionalwebhookEnv

webhookEnv?: string

消息协议中的 Webhook 环境标识。

Optionalpriority

priority?: MessagePriority

消息优先级。

OptionalneedReadReceipt

needReadReceipt?: boolean

是否需要消息已读回执。单聊和群聊均可使用。

OptionalisChatThread

isChatThread?: boolean

是否创建 Thread 回复消息，仅群聊 Thread 场景有效。

event

event: string

自定义事件名称。

Optionalparams

params?: Record<string, string>

自定义参数。

Settings

Member Visibility

On This Page

Properties