加好友接口

通过手机号加好友接口

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

请求示例:

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

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
phoneNumstring手机号
remarkstring备注信息
helloMsgstring邀请语
extraInfostring附加信息,回调原样返回
userIdstring机器人的userId,不填则由对应小组随机托管账号执行加好友操作

返回示例:

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

返回参数说明:

参数类型必定存在备注
codenumber返回码

添加好友回调

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则有返回错误信息
}

请求参数:

名称类型是否必须备注
codenumber错误码 0表示成功 1表示搜索不到或搜索失败
data.fromwxidstring企微号id
data.fromwxNamestring企微号名称
data.fromwxAvatarstring企微号头像
data.typenumber加好友的方式类型,1: 手机号 2: 群聊加好友 3: 名片加好友
data.phoneNumstring手机号,当type为1的时候存在
data.roomWxidstring群聊的wxid,当type为2的时候存在
data.contactSenderWxidstring发名片的联系人的wxid,当type为3的时候存在
data.extraInfostring附加信息
data.payloadobject当成功时 返回
data.payload.avatarstring头像
data.payload.namestring名字
data.payload.gendernumber0:未知 1:男 2:女
data.payload.wxidstring微信内部id
data.payload.friendboolean是否已经是好友
data.createTimestampnumber当前加好友任务的创建时间
data.sendTimestampnumber当前加好友任务的好友请求发送时间
messagestring当有问题时 返回错误信息

好友通过后回调

POST ***/friend/confirm

请求示例:

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

请求参数:

名称类型是否必须备注
codenumber错误码 0表示成功
data.fromwxidstring所属微信id
data.tokenstring请求的token
data.wxidstring通过请求的好友微信内部id
data.phoneNumstring添加的手机号
data.roomWxidstring群聊加好友的群wxid
data.contactSenderWxidstring名片加好友的发名片的好友的wxid
data.remarkstring用户备注
data.helloMsgstring邀请语
data.extraInfostring附加信息
data.externalUserIdstring客户的externalUserId
messagestring当有问题时 返回错误信息

TIP

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

群聊加好友接口

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

请求示例:

{
  "token": "xxx",
  "roomId": "R:10696049576015462", // 群聊wxid,该id在微信里唯一
  "contactId": "1688849967837780", // 群成员wxid
  "remark": "备注", //
  "helloMsg": "我是句子互动的XX,请添加我的企业微信", //邀请语
  "extraInfo": "{}", // 附加信息,回调原样返回
  "userId": "FuLiGuan", // 机器人的userId,必须保证该托管账号在传入的群聊中
}

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
roomIdstring群聊wxid,该id在微信里唯一
contactIdstring群成员wxid
remarkstring备注信息
helloMsgstring邀请语
extraInfostring附加信息
userIdstring机器人的userId,必须保证该托管账号在传入的群聊中

返回示例:

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

返回参数说明:

参数类型必定存在备注
codenumber返回码

code错误码说明

错误码说明
0成功
-1托管账号不存在
-2托管账号不在群聊内
-3群聊不存在
-4群成员不存在

群聊加好友接口通过企微id

POST https://ex-api.botorange.com/addFriend/room/sendByWecom

请求示例:

{
  "token": "xxx",
  "wecomChatId": "wrBkHDEQAAUrHK77bJU9z1hLinfNROca",
  "externalUserId": "wo4JW7EQAAQHKG9u_m4da3zq0hSJd5ee",
  "remark": "备注", //
  "helloMsg": "我是句子互动的XX,请添加我的企业微信", //邀请语
  "extraInfo": "{}", // 附加信息,回调原样返回
  "wecomUserId": "FuLiGuan",
}

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
wecomChatIdstring企微的群chatId
externalUserIdstring企微的客户id
remarkstring备注信息
helloMsgstring邀请语
extraInfostring附加信息
wecomUserIdstring机器人的企微userId,必须保证该托管账号在传入的群聊中

注意

因为涉及到数据修改,此接口支持 2022-08-26 之后登录的新账号。
历史托管账号想要使用此接口的,需要在 客户分层 -> 同步已有群聊 来更新数据,然后才可以使用该接口。

返回示例:

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

返回参数说明:

参数类型必定存在备注
codenumber返回码

code错误码说明

错误码说明
0成功
-1托管账号不存在
-2托管账号不在群聊内
-3群聊不存在
-4群成员不存在
最近更新:
Contributors: windmemory