# 小组控制台群聊加好友(addRoomFriend)
# 关于token
在小组控制台上添加微信号并扫码登录以后,在设置 ==> API接入页面即可找到自己的token
# 关于频率限制
每个秒回token的频次限制是500次/30s。
# 群聊加好友接口
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,必须保证该托管账号在传入的群聊中
}
# 请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
token | string | 是 | 调用接口凭证 |
roomId | string | 是 | 群聊wxid,该id在微信里唯一 |
contactId | string | 是 | 群成员wxid |
remark | string | 否 | 备注信息 |
helloMsg | string | 是 | 邀请语 |
extraInfo | string | 否 | 附加信息 |
userId | string | 是 | 机器人的userId,必须保证该托管账号在传入的群聊中 |
# 返回示例:
{
"code": 0, // 请求成功
}
# 返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|---|---|---|
code | number | 是 | 返回码 |
# code错误码说明
错误码 | 说明 |
---|---|
0 | 成功 |
-1 | 托管账号不存在 |
-2 | 托管账号不在群聊内 |
-3 | 群聊不存在 |
-4 | 群成员不存在 |