青鸾QINGLUAN
控制台

发送名片

发送名片。cardUserId 在请求体顶层,不在 content 里。

POST/qingluan/api/message/sendNameCard

接口说明

发送名片。cardUserId请求体顶层,不在 content 里。

请求参数

请求体必填。通过 QL-Key 请求头携带 APIKey。

Content-Type:application/json

请求参数。字段名区分大小写,请按文档原样传递。

appidstring必填

青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。

字段示例:"we_xxxxxxxxxxxxxxx"
conversationIdint64必填

会话 ID

会话 ID。群聊传群号,私聊传对方 uin。注意它超出 JavaScript 安全整数范围,JS 侧需按大整数处理,不要经过 Number()

字段示例:10000000000000000
cardUserIdint64必填

名片对应的用户 ID。⚠️ 字段名是 cardUserId不是 userId;且它在请求体顶层,不在 content 里。

字段示例:1688000000000001

响应与结果确认

本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。

发送后通过拉取消息复核。超时或网络中断时,先确认结果,再决定是否重试,避免重复消息。

响应字段与 HTTP 状态

HTTP 200

能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。

application/json

查看响应字段定义

接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。

codeinteger必填

业务状态码

业务状态码:0 表示成功,-1 表示失败;失败原因见 message

字段示例:0
dataobject可选

业务数据

业务返回数据;字段结构见下方定义。

idint64可选

对象 ID。发消息返回时即 serverMsgId(撤回要用);上传返回时即 fileId(发送/下载要用);列表项中为该条记录 ID

syncKeyint64可选

同步游标

同步键。下次增量同步传回

messageTypeint64可选

消息类型枚举(0=普通消息)

fromUserIdint64可选

发送方 ID

toUserIdint64可选

接收方 ID

roomIdint64可选

群聊 ID

群聊 ID。可从创建群、群列表、群详情或回调事件中获取。

contentTypeint64可选

内容类型。0=文本 14=图片(完整枚举见平台「企微错误码」章节)

sendTimeint64可选

发送时间戳(秒)

appInfostring可选

企微内部应用标识,透传字段,无需处理

senderNamestring可选

消息发送名称

contentobject可选

内容

消息/动态正文。纯文本类接口传字符串;媒体类传对象(把上传接口返回的 data 整体带上)

cardUserIdint64可选

名片对应的用户 ID。sendNameCard 必填(不是 userId)

avatarUrlstring可选

头像 URL

namestring可选

名称

名称/昵称

corpNamestring可选

企业名称。

corpIdint64可选

企业 ID

企业 ID。

displayNamestring可选

名片中展示的联系人名称。

detailstring可选

错误详情

错误详情;无补充信息时通常为空字符串。

messagestring必填

响应消息

业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息

字段示例:"ok"
timestring必填

服务端时间

服务端时间,格式为 YYYY-MM-DD HH:mm:ss

字段示例:"2026-07-21 07:33:17"

HTTP 403

受控接口,需通过控制台配置

HTTP 404

appid 不存在或无权访问

搜索接口

输入关键词查找接口。最多显示 20 项。