SDKsuni-app / uni-app x

创建自定义消息

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

创建自定义消息接口适合处理订单、任务、邀请或投票等需要同步给会话成员的结构化业务消息。

参数说明

参数	类型	是否必填	说明
`data`	`string`	是	完整业务数据字符串，通常为序列化后的 JSON。
`extension`	`string`	是	完整业务扩展字符串。
`descriptionText`	`string`	是	类型说明或不支持该类型时的降级展示文本。

import { createCustomMessage } from '@/uni_modules/unix-openim-sdk'

const message = await createCustomMessage({
  data: JSON.stringify({
    type: 'task',
    taskID: 'task_42',
  }),
  extension: JSON.stringify({ schemaVersion: 1 }),
  descriptionText: '任务卡片',
})
if (message == null) return

三个参数都是完整字符串，SDK 不会合并 JSON。接收端应按业务协议解析消息版本、字段和大小，并为不支持的版本提供降级展示。

Promise 成功只返回待发送的 OpenIMMessageItem | null。后续调用发送消息发送，并通过接收服务端业务通知或消息监听处理业务数据，客户端使用 clientMsgID 关联并更新本地状态。

这个页面有帮助吗？