# 通过扫一扫添加好友(平台号)

[异步回调] 通过扫一扫添加好友

请求方式:POST

请求地址:https://api.aquanliang.com/gateway/qopen/AddWechatViaScanQRCode

body参数

{
    "robot_id": "机器人id",
    "qr_code": "添加好友的二维码图片链接地址"
}
字段 类型 必填 说明
robot_id string 机器人id
qr_code string 添加好友的二维码图片链接地址(暂时不支持传入二维码解析地址)

返回值:

{
    "data": {
        "serial_no": "操作序列号"
    },
    "errcode": 0,
    "errmsg": ""
}

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
serial_no string 操作序列号

处理结果,异步返回值:

{
    "event_type": 200014,
    "serial_no": "操作序列号",
    "err_code": 0,
    "err_msg": "success",
    "robot_id": "机器人id",
    "data": {
      "contact_id": "联系人id",
      "name": "姓名",
      "base64_name": "BASE64编码过后的用户姓名",
      "profile_photo": "头像url",
      "gender": 1,
      "alias": "别名",
      "base64_alias": "BASE64编码过后的用户别名",
      "is_verified": true,
      "real_name": "真实姓名"
    }
}

返回说明

字段 类型 说明
event_type int 事件类型,200014
serial_no string 操作序列号
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
robot_id string 机器人id
data object 返回数据
data.contact_id string 联系人id
data.name string 姓名
data.base64_name string BASE64编码过后的用户姓名
data.profile_photo string 头像url
data.gender int 性别:1男 2女
data.alias string 别名
data.base64_alias string BASE64编码过后的用户别名
data.is_verified bool 是否可加客户好友:true可加;false不可加(非实名账号,无法加客户为好友)
data.real_name string 真实姓名

完整请求示例:

curl -X POST \
  https://api.aquanliang.com/gateway/qopen/AddWechatViaScanQRCode \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
    "robot_id": "机器人id",
    "qr_code": ""
}'