小组接口

获取chatId

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

请求参数:

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

注意

使用userId进行查询时,无法保证当前企业下该userId仅在一个微信组内托管了一次,如果以当前userId查到了不止一个托管账号,则会报错

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ"
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
chatIdstring联系人的chatId

错误码:

错误码说明
-1秒回没有绑定聚客宝
-2botUserId的bot不存在
-3botUserId存在多个机器人
-4contact不存在
-5chat不存在

获取chatId通过externalUserId

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

请求参数:

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

注意

使用userId进行查询时,无法保证当前企业下该userId仅在一个微信组内托管了一次,如果以当前userId查到了不止一个托管账号,则会报错

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ"
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
chatIdstring联系人的chatId

错误码:

错误码说明
-1秒回没有绑定聚客宝
-2botUserId的bot不存在
-3botUserId存在多个机器人
-4contact不存在
-5chat不存在

创建群聊

POST https://hub.juzibot.com/api/v1/instantReply/createRoom?token=*

请求示例:

{
  "botUserId": "testUserId",
  "userIds": [
    "zhangsan"
  ],
  "unionIds": [
    "ozynqsulJFCZ2z1aYeS8h-nuasdAAA"
  ],
  "name": "create",
  "greeting": "大家好,这个是新的群",
  "externalUserIds": [
    "wmrRhyBgAA6PKOL7IA2Nbikedjxxxxxx",
    "wmrRhyBgAANQ1O34HRXfVQh17exxxxxx"
  ]
}

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证,通过query传入
botUserIdstring需要执行建群的托管微信的userId
userIdsstring array建群时需要拉入的企业成员的userId
unionIdsstring array建群时需要拉取的外部联系人的unionId
namestring建群后新的群的名字
greetingstring建群后的激活语
externalUserIdsstring array建群时需要拉取的联系人的externalUserId

注意

使用userId进行建群时,无法保证当前企业下该userId仅在一个微信组内托管了一次,如果以当前userId查到了不止一个托管账号,则会报错。

创建群聊时 unionIdsexternalUserId 联系人组合的总人数应位于2~40之间,两个参数可以共存。

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
    "roomWxid": "R:888888888"
  }
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
data.chatIdstring创建的群聊的chatId
data.roomWxidstring创建的群聊的wxid

错误码:

错误码说明
-1秒回没有绑定聚客宝
-2botUserId的bot不存在
-3botUserId存在多个机器人
-4不是企业微信
-5bot不在线
-6同事不存在
-7contact不存在
-8contact加载失败
-9创建群聊失败
-10创建群人数不足

移出群聊

POST https://hub.juzibot.com/api/v1/instantReply/removeFromRoom?token=*

请求示例:

{
  "botUserId": "testUserId",
  "contactWxid": "7888888888",
  "roomWxid": "R:888888"
}

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证,通过query传入
botUserIdstring需要执行移出的托管微信的userId
contactWxidstring需要被移出的群成员的wxid
roomWxidstring需要被移出的群的wxid

注意

使用userId进行移出群聊时,无法保证当前企业下该userId仅在一个微信组内托管了一次,如果以当前userId查到了不止一个托管账号,则会报错

返回示例:

{
  "errcode": 0,
  "errmsg": "ok"
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

错误码:

错误码说明
-1秒回没有绑定聚客宝
-2botUserId的bot不存在
-3botUserId存在多个机器人
-4不是企业微信
-5bot不在线
-6群聊加载失败
-7群聊中没有移除对象

加入群聊

POST https://hub.juzibot.com/api/v1/instantReply/addFromRoom?token=*

请求示例:

{
  "botUserId": "testUserId",
  "contactWxid": "7888888888",
  "roomWxid": "R:888888"
}

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证,通过query传入
botUserIdstring需要执行添加的托管微信的userId
contactWxidstring需要被添加的群成员的wxid
roomWxidstring需要被添加的群的wxid

注意

1.使用userId进行添加群聊时,无法保证当前企业下该userId仅在一个微信组内托管了一次,如果以当前userId查到了不止一个托管账号,则会报错 2.群人数40人之前默认拉入群聊,40人以后发送入群卡片链接,需要客户点击确认 3.建议拉人进群时,每分钟不超过50次

返回示例:

{
  "errcode": 0,
  "errmsg": "ok"
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容

错误码:

错误码说明
-1企业控制台没有绑定企业控制台
-2botUserId的bot不存在
-3botUserId存在多个机器人
-4不是企业微信
-5bot不在线
-6群聊加载失败
-7拉入群聊失败
-8和bot不是好友关系
-9群聊中已经存在此好友
-10群人数达到上限(500)
-11bot不在群内
-12该群是内部群,不执行此操作

获取API配置信息

GET https://hub.juzibot.com/api/v1/instantReply/mhAPI/get?token=*

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证

返回示例:

{
  "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": "句子互动x"
    }
  ]
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
dataarray配置数据
data.groupIdstring组id
data.groupNamestring组名称
data.enabledboolean配置开关
data.externalEndpointstring回调地址
data.relatedOnlyboolean仅推送相关消息
data.ignoreHelloboolean忽略加好友打招呼
data.sendFriendConfirmboolean发送确认
data.sentResultNotifyboolean发送结果通知
data.botMessageboolean推送账号自己的消息
data.tokenstring小组级调用接口凭证

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

请求参数:

名称类型是否必须备注
tokenstring企业控制台token, 用于调用接口凭证
groupIdstring标签组id
enabledboolean配置开关
externalEndpointstring回调地址
relatedOnlyboolean仅推送相关消息
ignoreHelloboolean忽略加好友打招呼
sendFriendConfirmboolean发送确认
sentResultNotifyboolean发送结果通知
botMessageboolean推送账号自己的消息

返回示例:

{
  "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"
  }
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
dataobject配置数据
data.groupIdstring标签组id
data.groupNamestring标签组名称
data.enabledboolean配置开关
data.externalEndpointstring回调地址
data.relatedOnlyboolean仅推送相关消息
data.ignoreHelloboolean忽略加好友打招呼
data.sendFriendConfirmboolean发送确认
data.sentResultNotifyboolean发送结果通知
data.botMessageboolean推送账号自己的消息
data.tokenstring调用接口凭证

获取托管账号所在微信分组的信息

GET https://hub.juzibot.com/api/v1/bot/getGroupBots?token=*

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "groups": [{
    "id": "groupId",
    "name": "groupName",
    "bots": [{
      "id": "botId",
      "wxid": "botWxid",
      "wecomUserId": "wxUserId",
      "status": 1,
      "name": "botName",
      "avatar": "botAvatar"
    }]
  }]
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
groups.idstring小组id
groups.namestring小组名
groups.bots.idstring托管账号id
groups.bots.wxidstring托管账号wxid
groups.bots.wecomUserIdstring托管账号的企微userId
groups.bots.statusBotStatus托管账号状态
groups.bots.namestring托管账号名字
groups.bots.avatarstring托管账号头像
enum BotStatus {
  OFFLINE = 1, // 离线
  ONLINE = 2,  // 在线
  WRONG_ACCOUNT = 3,  // 登录错误账号
  ERROR_LOGOUT = 4, // 错误退出
  NOT_TRUSTEESHIP = 5, // 已邀请未托管
}
最近更新:
Contributors: SilentQianyi, windmemory