# 通过手机号加好友

# 注意事项:

  • 系统支持使用者根据自身需求做自定义调度,原则上单个机器人的请求不支持同时触发并行,建议单个机器人每个好友请求的间隔在1分钟以上,当日单个机器人加的好友数不超过20个;
  • 对同一个机器人同时发起多个请求,系统不会协助做调度,可能出现验证语错乱的情况
  • 若不希望自行开发调度规则,请使用我们的规则主加功能点击查看:规则主加文档

[异步回调]通过手机号发送好友申请

请求方式:POST

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

body参数

{
    "robot_id": "机器人id",
    "mark_id": "{{uuid}}",
    "ext_user":{
        "mobile": "手机号码",
        "validation_message": "加好友验证信息"
    },
    "contact_type": 1
}
字段 类型 必填 说明
robot_id string 机器人id
ext_user object 需要添加的好友信息
ext_user.mobile string 手机号码
ext_user.validation_message string 加好友验证信息,最大长度50个字符
ext_user.tag_list array 标签列表,需要传入企业标签
mark_id string 标识字段,成为好友后(20001)中返回
contact_type int 1:个微 2:企微; 兼容原有逻辑 不传或者传0示作个微

返回值:

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

处理结果,异步返回值:

{
    "event_type": 40029,
    "err_code": 0,
    "err_msg": "success",
    "serial_no": "请求序列号",
    "robot_id": "发送请求的机器人id",
    "mobile": "好友手机号"
}

说明

字段 类型 说明
event_type int 事件类型,40029
err_code int 状态码,0为正常,非0代表错误
err_msg string 错误信息
serial_no string 请求序列号
robot_id string 发送请求的机器人id
mobile string 好友的手机号

完整请求示例:

curl -X POST \
  https://$basehost/gateway/qopen/AddExtUserByPhone \
  -H 'Content-Type: application/json; charset=UTF-8' \
  -H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
  -d '{
    "robot_id": "机器人id",
    "ext_user":{
        "mobile": "手机号码",
        "validation_message": "加好友验证信息"
    }
}'

最后更新时间: 2024/12/6 16:30:00