# 小组控制台添加好友接口（addFriend）

# 关于token

在小组控制台上添加微信号并扫码登录以后，在设置 ==> API接入页面即可找到自己的token

# 关于频率限制

每个秒回token的频次限制是500次/30s。

# 加好友接口

POST https://ex-api.botorange.com/addFriend/send

# 请求示例：

{
  "token": "xxx", // 获取请参考图一
  "phoneNum": "13538551111", // 手机号
  "remark": "用户备注", //自动打上备注， 可选
  "helloMsg": "我是句子互动的XX，请添加我的企业微信", //邀请语
  "extraInfo": "{}", // 附加信息，回调原样返回
  "userId": "FuLiGuan", // 机器人的userId，不填则由对应小组随机托管账号执行加好友操作
}

# 请求参数：

名称	类型	是否必须	备注
token	string	是	调用接口凭证
phoneNum	string	是	手机号
remark	string	否	备注信息
helloMsg	string	是	邀请语
extraInfo	string	否	附加信息，回调原样返回
userId	string	否	机器人的userId，不填则由对应小组随机托管账号执行加好友操作

# 返回示例：

{
  "code": 0, // 请求成功
}

# 返回参数说明：

参数	类型	必定存在	备注
code	number	是	返回码

# 添加好友回调

POST ***/friend/send

# 请求示例：

{
  "code": 0, // 0 发送成功， 1 搜索不到或搜索失败
  "data": {
    "fromwxid": "168...", // 企微号id
    "fromwxName": "张三", // 企微号名称
    "fromwxAvatar": "http://wx.qlogo..", // 企微号头像
    "type": 1, // 1 手机号加好友，2 群聊加好友，3 名片加好友
    "phoneNum": "13538551111", // 手机号（type为1时存在）
    "roomWxid": "R:1111111", // 加好友的群聊wxid（type为2时存在）
    "contactSenderWxid": "12345678", // 发送名片的联系人wxid（type为3时存在）
    "extraInfo": "", //
    "payload": { // 0则返回
      "avatar": "http://wx.qlogo.cn/mmhead/OibRNdtlJ..", // 头像
      "name": "XX", //名字
      "gender": 2, // 性别， 0 未知 1 男 2 女
      "wxid": "788748399949943", // 微信内部id
      "friend": true, // 是否已经是好友
    },
    "createTimestamp": 1620736936935, // 任务创建时间
    "sendTimestamp": 1620736947934, // 好友申请发送时间
    "token": "xxx", // token
  },
  "message": "", // 1则有返回错误信息
}

# 请求参数：

名称	类型	是否必须	备注
code	number	是	错误码 0表示成功 1表示搜索不到或搜索失败
data.fromwxid	string	是	企微号id
data.fromwxName	string	是	企微号名称
data.fromwxAvatar	string	是	企微号头像
data.type	number	是	加好友的方式类型，1: 手机号 2: 群聊加好友 3: 名片加好友
data.phoneNum	string	否	手机号，当type为1的时候存在
data.roomWxid	string	否	群聊的wxid，当type为2的时候存在
data.contactSenderWxid	string	否	发名片的联系人的wxid，当type为3的时候存在
data.extraInfo	string	是	附加信息
data.payload	object	否	当成功时返回
data.payload.avatar	string	是	头像
data.payload.name	string	是	名字
data.payload.gender	number	是	0:未知 1:男 2:女
data.payload.wxid	string	是	微信内部id
data.payload.friend	boolean	是	是否已经是好友
data.createTimestamp	number	是	当前加好友任务的创建时间
data.sendTimestamp	number	是	当前加好友任务的好友请求发送时间
message	string	否	当有问题时返回错误信息

# 好友通过后回调

POST ***/friend/confirm

# 请求示例：

{
  "code": 0, // 0 成功
  "data": {
    "fromwxid": "16837362837774", // 所属微信id
    "token": "xxx", // 请求的token
    "wxid": "788748399949943", // 通过请求的好友微信内部id
    "phoneNum": "13538551111",
    "remark": "用户备注",
    "helloMsg": "我是句子互动的张敏，请添加我的企业微信",
    "extraInfo": "{}" //附加信息
  },
  "message": ""
}

# 请求参数：

名称	类型	是否必须	备注
code	number	是	错误码 0表示成功
data.fromwxid	string	是	所属微信id
data.token	string	是	请求的token
data.wxid	string	是	通过请求的好友微信内部id
data.phoneNum	string	否	添加的手机号
data.roomWxid	string	否	群聊加好友的群wxid
data.contactSenderWxid	string	否	名片加好友的发名片的好友的wxid
data.remark	string	是	用户备注
data.helloMsg	string	是	邀请语
data.extraInfo	string	是	附加信息
message	string	否	当有问题时返回错误信息

TIP

wxid 是唯一的，phoneNum 不一定唯一