小组接口
获取chatId
GET https://hub.juzibot.com/api/v1/instantReply/getChatId?token=*&unionId=*
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证, 获取方式 |
unionId | string | 是 | 联系人的unionId |
botUserId | string | 是 | 托管的企业微信的userId, 详见wxUserId |
注意
使用userId
进行查询时,无法保证当前企业下该userId
仅在一个微信组内托管了一次,如果以当前userId
查到了不止一个托管账号,则会报错
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ"
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
chatId | string | 是 | 联系人的chatId |
错误码:
错误码 | 说明 |
---|
-1 | 秒回没有绑定聚客宝 |
-2 | botUserId的bot不存在 |
-3 | botUserId存在多个机器人 |
-4 | contact不存在 |
-5 | chat不存在 |
获取chatId通过externalUserId
GET https://hub.juzibot.com/api/v1/instantReply/getChatIdByExternalUserId?token=*&externalUserId=*
请求参数:
注意
使用userId
进行查询时,无法保证当前企业下该userId
仅在一个微信组内托管了一次,如果以当前userId
查到了不止一个托管账号,则会报错
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ"
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
chatId | string | 是 | 联系人的chatId |
错误码:
错误码 | 说明 |
---|
-1 | 秒回没有绑定聚客宝 |
-2 | botUserId的bot不存在 |
-3 | botUserId存在多个机器人 |
-4 | contact不存在 |
-5 | chat不存在 |
创建群聊
POST https://hub.juzibot.com/api/v1/instantReply/createRoom?token=*
请求示例:
{
"botUserId": "testUserId",
"userIds": [
"zhangsan"
],
"unionIds": [
"ozynqsulJFCZ2z1aYeS8h-nuasdAAA"
],
"name": "create",
"greeting": "大家好,这个是新的群",
"externalUserIds": [
"wmrRhyBgAA6PKOL7IA2Nbikedjxxxxxx",
"wmrRhyBgAANQ1O34HRXfVQh17exxxxxx"
]
}
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证,通过query传入, 获取方式 |
botUserId | string | 是 | 需要执行建群的托管微信的userId, 详见wxUserId |
userIds | string array | 是 | 建群时需要拉入的企业成员的userId, 详见wxUserId |
unionIds | string array | 否 | 建群时需要拉取的外部联系人的unionId |
name | string | 否 | 建群后新的群的名字 |
greeting | string | 是 | 建群后的激活语 |
externalUserIds | string array | 否 | 建群时需要拉取的联系人的externalUserId |
注意
使用userId
进行建群时,无法保证当前企业下该userId
仅在一个微信组内托管了一次,如果以当前userId
查到了不止一个托管账号,则会报错。
创建群聊时 unionIds
和 externalUserId
联系人组合的总人数应位于2~40之间,两个参数可以共存。
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"data": {
"chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
"roomWxid": "R:888888888"
}
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data.chatId | string | 是 | 创建的群聊的chatId, 详见wecomChatId |
data.roomWxid | string | 是 | 创建的群聊的wxid, 详见roomWxid |
错误码:
错误码 | 说明 |
---|
-1 | 秒回没有绑定聚客宝 |
-2 | botUserId的bot不存在 |
-3 | botUserId存在多个机器人 |
-4 | 不是企业微信 |
-5 | bot不在线 |
-6 | 同事不存在 |
-7 | contact不存在 |
-8 | contact加载失败 |
-9 | 创建群聊失败 |
-10 | 创建群人数不足 |
移出群聊
POST https://hub.juzibot.com/api/v1/instantReply/removeFromRoom?token=*
请求示例:
{
"botUserId": "testUserId",
"contactWxid": "7888888888",
"roomWxid": "R:888888"
}
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证,通过query传入, 获取方式 |
botUserId | string | 是 | 需要执行移出的托管微信的userId, 详见wxUserId |
contactWxid | string | 是 | 需要被移出的群成员的wxid, 详见contactWxid |
roomWxid | string | 是 | 需要被移出的群的wxid, 详见roomWxid |
注意
使用userId
进行移出群聊时,无法保证当前企业下该userId
仅在一个微信组内托管了一次,如果以当前userId
查到了不止一个托管账号,则会报错
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
错误码:
错误码 | 说明 |
---|
-1 | 秒回没有绑定聚客宝 |
-2 | botUserId的bot不存在 |
-3 | botUserId存在多个机器人 |
-4 | 不是企业微信 |
-5 | bot不在线 |
-6 | 群聊加载失败 |
-7 | 群聊中没有移除对象 |
加入群聊
POST https://hub.juzibot.com/api/v1/instantReply/addFromRoom?token=*
请求示例:
{
"botUserId": "testUserId",
"contactWxid": "7888888888",
"roomWxid": "R:888888"
}
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证,通过query传入, 获取方式 |
botUserId | string | 是 | 需要执行添加的托管微信的userId, 详见wxUserId |
contactWxid | string | 是 | 需要被添加的群成员的wxid, 详见contactWxid |
roomWxid | string | 是 | 需要被添加的群的wxid, 详见roomWxid |
注意
1.使用userId
进行添加群聊时,无法保证当前企业下该userId
仅在一个微信组内托管了一次,如果以当前userId
查到了不止一个托管账号,则会报错 2.群人数40人之前默认拉入群聊,40人以后发送入群卡片链接,需要客户点击确认 3.建议拉人进群时,每分钟不超过50次
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
错误码:
错误码 | 说明 |
---|
-1 | 企业控制台没有绑定企业控制台 |
-2 | botUserId的bot不存在 |
-3 | botUserId存在多个机器人 |
-4 | 不是企业微信 |
-5 | bot不在线 |
-6 | 群聊加载失败 |
-7 | 拉入群聊失败 |
-8 | 和bot不是好友关系 |
-9 | 群聊中已经存在此好友 |
-10 | 群人数达到上限(500) |
-11 | bot不在群内 |
-12 | 该群是内部群,不执行此操作 |
获取API配置信息
GET https://hub.juzibot.com/api/v1/instantReply/mhAPI/get?token=*
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证, 获取方式 |
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"groupId": "60cb3e65ed1c6b87aa450d77",
"groupName": "北京x",
"enabled": true,
"externalEndpoint": "abcd",
"relatedOnly": false,
"ignoreHello": false,
"sendFriendConfirm": false,
"sentResultNotify": false,
"token": "60e2b6a32fc40f0b4d65f2bc",
"botMessage": false
},
{
"groupId": "60cb3e65ed1c6b87aa450d79",
"groupName": "yzx"
}
]
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data | array | 是 | 配置数据 |
data.groupId | string | 是 | 秒回组id, 详见groupId |
data.groupName | string | 是 | 组名称 |
data.enabled | boolean | 否 | 配置开关 |
data.externalEndpoint | string | 否 | 回调地址 |
data.relatedOnly | boolean | 否 | 仅推送相关消息 |
data.ignoreHello | boolean | 否 | 忽略加好友打招呼 |
data.sendFriendConfirm | boolean | 否 | 发送确认 |
data.sentResultNotify | boolean | 否 | 发送结果通知 |
data.botMessage | boolean | 否 | 推送账号自己的消息 |
data.token | string | 否 | 小组级调用接口凭证, 详见小组级token |
修改API配置信息
POST https://hub.juzibot.com/api/v1/instantReply/mhAPI/update?token=*
请求示例:
{
"groupId": "groupId",
"enabled": true,
"externalEndpoint": "http://callback",
"relatedOnly": false,
"ignoreHello": false,
"sendFriendConfirm": true,
"sentResultNotify": true,
"botMessage": false
}
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 企业控制台token, 用于调用接口凭证, 获取方式 |
groupId | string | 是 | 标签组id, 详见wechatyTagGroupId |
enabled | boolean | 是 | 配置开关 |
externalEndpoint | string | 是 | 回调地址 |
relatedOnly | boolean | 否 | 仅推送相关消息 |
ignoreHello | boolean | 否 | 忽略加好友打招呼 |
sendFriendConfirm | boolean | 否 | 发送确认 |
sentResultNotify | boolean | 否 | 发送结果通知 |
botMessage | boolean | 否 | 推送账号自己的消息 |
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"data": {
"groupId": "60cb3e65ed1c6b87aa450d77",
"groupName": "北京x",
"enabled": true,
"externalEndpoint": "abcd",
"relatedOnly": false,
"ignoreHello": false,
"sendFriendConfirm": false,
"sentResultNotify": false,
"botMessage": false,
"token": "60e2b6a32fc40f0b4d65f2bc"
}
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data | object | 是 | 配置数据 |
data.groupId | string | 是 | 标签组id |
data.groupName | string | 是 | 标签组名称 |
data.enabled | boolean | 否 | 配置开关 |
data.externalEndpoint | string | 否 | 回调地址 |
data.relatedOnly | boolean | 否 | 仅推送相关消息 |
data.ignoreHello | boolean | 否 | 忽略加好友打招呼 |
data.sendFriendConfirm | boolean | 否 | 发送确认 |
data.sentResultNotify | boolean | 否 | 发送结果通知 |
data.botMessage | boolean | 否 | 推送账号自己的消息 |
data.token | string | 否 | 调用接口凭证, 详见小组级token |
获取托管账号所在微信分组的信息
GET https://hub.juzibot.com/api/v1/bot/getGroupBots?token=*
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证, 获取方式 |
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"groups": [{
"id": "groupId",
"name": "groupName",
"bots": [{
"id": "botId",
"wxid": "botWxid",
"wecomUserId": "wxUserId",
"status": 1,
"name": "botName",
"avatar": "botAvatar"
}]
}]
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
groups.id | string | 是 | 小组id, 详见groupId |
groups.name | string | 是 | 小组名 |
groups.bots.id | string | 是 | 托管账号id, 详见botId |
groups.bots.wxid | string | 是 | 托管账号wxid, 详见imBotId |
groups.bots.wecomUserId | string | 是 | 托管账号的企微userId, 详见wxUserId |
groups.bots.status | BotStatus | 是 | 托管账号状态 |
groups.bots.name | string | 是 | 托管账号名字 |
groups.bots.avatar | string | 是 | 托管账号头像 |
enum BotStatus {
OFFLINE = 1,
ONLINE = 2,
WRONG_ACCOUNT = 3,
ERROR_LOGOUT = 4,
NOT_TRUSTEESHIP = 5,
}