请求地址
POST https://api.qingluanbot.com/qingluan/api/contact/phoneNumberAddWechat
请求示例
curl -X POST 'https://api.qingluanbot.com/qingluan/api/contact/phoneNumberAddWechat' \
-H 'QL-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"appid": "we_xxxxxxxxxxxxxxx",
"openid": "<省略>",
"remarkPhone": [
{
"phone": "13800000000"
}
],
"ticket": "<省略>",
"verifyMessage": "您好，我想添加您为好友"
}'
请求参数
| 字段 | 类型 | 要求 | 说明 |
|---|
appid | string | 必填 | 青鸾实例 ID，形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。 |
ticket | string | 必填 | 凭证。由搜索/名片接口返回 注意：与 openid 同批由搜索接口返回。属凭证类字段，日志与落库须脱敏。 |
openid | string | 必填 | 微信 OpenId 注意：来自 /api/contact/phoneNumberSearch 的返回。这两个接口是成对使用的：先用手机号搜到人，再用搜到的 openid 发起添加。 |
verifyMessage | string | 必填 | 好友申请附言。 |
remarkPhone | array<object> | 必填 | 备注手机号列表，对象数组，元素形如 {"phone": "13800000000"}。不填时传空数组 []，不要传空字符串。 |
响应判断
能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。
可能的响应状态
| HTTP 状态 | 公开契约说明 |
|---|
200 | 原样返回（code = 0 即成功） |
403 | 受控接口，需通过控制台配置 |
404 | appid 不存在或无权访问 |
200 响应示例
{
"code": 0,
"data": {}
}
接入步骤
- 在青鸾开发者控制台创建或查看 API Key。
- 在「实例与回调」接入企业微信账号，取得
appid。 - 请求头携带
QL-Key，按当前契约提交 JSON 请求。 - 读取响应中的
code；仅当 code=0 时按成功流程处理。