SDKsHarmonyOS商业版

创建自定义消息

创建包含结构化业务数据的自定义消息。

自定义消息适合订单、任务、邀请或投票等需要同步给会话成员的业务内容。

import sdk, { CreateCustomMessageReq, CreateCustomMessageResp } from '@openimsdk/imsdk';

const request: CreateCustomMessageReq = {
  data: JSON.stringify({ type: 'task', taskID: 'task_42' }),
  extension: JSON.stringify({ schemaVersion: 1 }),
  description: '任务卡片',
  searchText: '项目任务',
};
const response: CreateCustomMessageResp = await sdk.createCustomMessage(request);
const message = response.message;

data 和 extension 都是完整字符串，SDK 不会合并 JSON；description 用于类型说明或降级展示，searchText 可提供可检索文本。接收端根据双方约定的数据结构解析内容，无法识别的版本可以回退到 description。

这个页面有帮助吗？