通过名片添加

通过名片添加联系人。入参字段为 userId（旧契约中的 cardSourceUserId 已废弃）。

POST/qingluan/api/contact/addCard

接口说明

通过名片添加联系人。入参字段为 userId（旧契约中的 cardSourceUserId 已废弃）。

ticket 取自「同步外部联系人」（businessId = 1）的 list[].content.extraInfo.openimAddContactRspTicket，长度约 512 字符。 ⚠️ 会话中收到的名片消息本身不携带该凭证，无法仅凭收到的名片完成添加。

请求参数

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

Content-Type：application/json

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

appidstring必填

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

字段示例："we_xxxxxxxxxxxxxxx"

ticketstring必填

凭证。由搜索/名片接口返回

注意：契约称由搜索/名片接口返回，但未取得过确认有效的名片 ticket，因此无法判断 -2013 是否由 ticket 无效引起。属凭证类字段，日志须脱敏。

字段示例：""

verifyMessagestring必填

好友申请附言。

字段示例：""

userIdint64必填

用户 ID

用户 ID。同事取通讯录 vid，外部联系人取 uin。

字段示例：1000000000000001

响应与结果确认

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

请结合业务数据与本页说明判断实际状态，不要仅凭响应码推断操作效果。

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

业务状态码：0 表示成功，-1 表示失败；失败原因见 message。

字段示例：0

dataobject可选

业务数据

接口无固定结构化返回数据；成功时通常为空对象或省略 data。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例："ok"

timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

请求示例

请求示例 · JSON

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "ticket": "",
  "verifyMessage": "",
  "userId": 1000000000000001
}

响应示例

HTTP 200 响应示例 · JSON

{
  "code": 0,
  "data": {},
  "detail": "",
  "message": "ok",
  "time": "2026-07-21 07:33:17"
}

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

请结合业务数据与本页说明判断实际状态，不要仅凭响应码推断操作效果。