浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x

创建联系人名片消息

创建一条用于分享用户身份信息的联系人名片消息。

复制

createCardMessage() 创建联系人名片消息。名片中的资料是创建时写入消息的内容,不会随用户资料后续变化自动更新。

参数说明

参数类型是否必填说明
userIDstring被分享用户的稳定用户 ID。
nicknamestring名片展示名称。
faceURLstring名片头像地址。
exstring业务扩展字符串;SDK 不会自动合并或解析 JSON。
import { createCardMessage } from '@/uni_modules/unix-openim-sdk'

const message = await createCardMessage({
  userID: 'user_42',
  nickname: 'Alex',
  faceURL: 'https://example.com/avatar/user_42.png',
  ex: JSON.stringify({ source: 'team-directory' }),
})
if (message == null) return

接口字段均可空,但一张可识别的名片至少应包含有效的 userID 和展示名称。接收端执行添加好友、发起会话等操作前,应重新查询用户资料并检查当前权限,不要把名片内容当作实时身份凭据。

Promise 成功只返回待发送的 OpenIMMessageItem | null,不会发送消息或更新用户资料。