请求地址
POST https://api.qingluanbot.com/qingluan/api/message/sendNameCard
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/message/sendNameCard' \
-H 'X-Qingluan-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"ql_appid": "inst_xxxxxxxxxxxx",
"cardUserId": 1000000000000018,
"conversationId": 10000000000000006
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
ql_appid | string | 必填 | 青鸾实例 ID，形如 inst_xxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
conversationId | integer | 必填 | 会话 ID。群聊传群号，私聊传对方 uin。注意它超出 JavaScript 安全整数范围，JS 侧需按大整数处理，不要经过 Number()。 |
cardUserId | integer | 必填 | 名片对应的用户 ID。⚠️ 字段名是 cardUserId，不是 userId；且它在请求体顶层，不在 content 里。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | ql_appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {
"content": {
"avatarUrl": "<省略>",
"cardToken": "<省略>",
"cardUserId": 1000000000000018,
"corpId": 1000000000000002,
"corpName": "示例企业",
"displayName": "张三",
"name": "张三"
},
"contentType": 41,
"flag": 83886080,
"fromUserId": 1000000000000001,
"id": 1001253,
"messageType": 1,
"roomId": "10000000000000006",
"sendTime": 1788423389,
"senderName": "小艺",
"syncKey": 44527019,
"toUserId": 0
}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
ql_appid。 - 请求头携带
X-Qingluan-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。