按手机号添加企业微信用户

按手机号添加企业微信用户。入参取自「按手机号搜索」的返回。⚠️ 字段名是全小写 userid；不能添加自己。

POST/qingluan/api/contact/phoneNumberAddWework

在线调试鉴权与基础约定

接口说明

按手机号添加企业微信用户。入参取自「按手机号搜索」的返回。⚠️ 字段名是全小写 userid；不能添加自己。

请求参数

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

Content-Type：application/json

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

appidstring必填

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

字段示例："we_xxxxxxxxxxxxxxx"

useridint64必填

企业微信用户 ID

目标用户 ID。⚠️ 注意字段名是全小写 userid，与其他接口的 userId 不一致。

字段示例：0

corpIdint64必填

企业 ID

企业 ID。

注意：目标方所属企业 ID。未用真实他企业的 corpId 验证过成功路径。

字段示例：0

ticketstring必填

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

注意：契约称由搜索/名片接口返回，但企微侧取 ticket 的具体入口未确认（已验证的 phoneNumberSearch 是个微链路）。

字段示例：""

verifyMessagestring必填

好友申请附言。

字段示例："你好，我是某某，很高兴认识你"

remarkPhoneobject[]必填

备注手机号列表，对象数组，元素形如 {"phone": "13800000000"}。不填时传空数组 []，不要传空字符串。

数组元素 · object

phonestring必填

手机号

手机号（11 位）

字段示例：""

响应与结果确认

本接口为能力层原样返回，不统一增加青鸾外层信封。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",
  "corpId": 1000000000000002,
  "remarkPhone": [
    {
      "phone": "13800000000"
    }
  ],
  "ticket": "<省略>",
  "userid": 1000000000000018,
  "verifyMessage": "您好，我想添加您为好友"
}

响应示例

HTTP 200 响应示例 · JSON

{
  "code": 0,
  "data": {}
}

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

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