# 小组控制台接口 v1 (Beta)

# Beta 测试中

本接口处于 Beta 测试阶段，可能后续会根据 Beta 测试过程中遇到的问题做一些调整，请知悉

# 关于token

v1版本的接口使用企业控制台的token，并且和企业控制台API使用相同的接口地址

# 获取chatId

GET https://hub.juzibot.com/api/v1/instantReply/getChatId?token=*&unionId=*

# 请求参数：

名称	类型	是否必须	备注
token	string	是	调用接口凭证
unionId	string	是	联系人的unionId
botUserId	string	是	托管的企业微信的userId

注意

使用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=*

# 请求参数：

名称	类型	是否必须	备注
token	string	是	调用接口凭证
externalUserId	string	是	联系人的externalUserId
botUserId	string	是	托管的企业微信的userId

注意

使用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
userIds	string array	是	建群时需要拉入的企业成员的userId
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
data.roomWxid	string	是	创建的群聊的wxid

# 错误码：

错误码	说明
-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
contactWxid	string	是	需要被移出的群成员的wxid
roomWxid	string	是	需要被移出的群的wxid

注意

使用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
contactWxid	string	是	需要被添加的群成员的wxid
roomWxid	string	是	需要被添加的群的wxid

注意

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"
    },
    {
      "groupId": "60cb3e65ed1c6b87aa450d79",
      "groupName": "句子互动x"
    }
  ]
}

# 返回参数说明：

参数	类型	必定存在	备注
errcode	number	是	返回码
errmsg	string	是	对返回码的文本描述内容
data	array	是	配置数据
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.token	string	否	调用接口凭证

# 修改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
}

# 请求参数：

名称	类型	是否必须	备注
token	string	是	企业控制台token, 用于调用接口凭证
groupId	string	是	标签组id
enabled	boolean	是	配置开关
externalEndpoint	string	是	回调地址
relatedOnly	boolean	否	仅推送相关消息
ignoreHello	boolean	否	忽略加好友打招呼
sendFriendConfirm	boolean	否	发送确认
sentResultNotify	boolean	否	发送结果通知

# 返回示例：

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "groupId": "60cb3e65ed1c6b87aa450d77",
    "groupName": "北京句子互动x",
    "enabled": true,
    "externalEndpoint": "abcd",
    "relatedOnly": false,
    "ignoreHello": false,
    "sendFriendConfirm": false,
    "sentResultNotify": 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.token	string	否	调用接口凭证

← 小组控制台接口（legacy）侧边栏JS-SDK →