# 确认单边好友为客户(平台号)

[异步回调]确认单边好友为客户

说明:可通过调用该接口可将机器人的单边好友确认为客户。

此处的单边好友的场景是指机器人关闭了好友验证开关之后被好友添加时,机器人会存在于这个好友的通讯录中,但是该好友此时未在机器人的通讯录中。

请求方式:POST

请求地址:https://$basehost/gateway/qopen/ConfirmAsSidedCustomer

body参数

{
    "robot_id": "机器人id",
    "contact_id": "单边好友id"
}
字段 类型 必填 说明
robot_id string 机器人id
contact_id string 单边好友id

返回值:

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

返回说明

字段 类型 说明
errcode int 状态码,0为正常,非0代表错误
errmsg string 错误信息
data json json返回值
   serial_no string 请求序列号
hint string 请求日志ID

处理结果,异步返回值:

{
    "event_type": 703123,
    "serial_no": "操作序列号",
    "err_code": 0,
    "err_msg": "success",
    "data": {
        "contact_id": "客户id",
        "name": "姓名",
        "base64_name": "BASE64编码过后的用户姓名",
        "profile_photo": "头像",
        "gender": 1,
        "alias": "别名",
        "base64_alias": "BASE64编码过后的用户别名",
        "is_verified": true,
        "real_name": "实名姓名",
        "company": "所属企业"
    }
}

返回说明

字段 类型 说明
event_type int 事件类型,703123
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 头像
data.gender int 性别:1男 2女
data.alias string 别名
data.base64_alias string BASE64编码过后的用户别名
data.is_verified bool 是否可加客户好友:true可加;false不可加(非实名账号,无法加客户为好友)
data.real_name string 实名姓名
data.company string 所属企业

完整请求示例:

curl -X POST \
  https://$basehost/gateway/qopen/ConfirmAsSidedCustomer \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
    "robot_id": "机器人id",
    "contact_id": "客户id"
}'
最后更新时间: 2023/5/24 10:48:59