基础接口

获取托管企业微信列表

GET https://ex-api.botorange.com/bot/list

参数:

token, // 必选

参数需要通过url传入,例如:

GET https://ex-api.botorange.com/bot/list?token={your-token}

返回数据为json格式,具体格式如下:

{
  "code": 0,
  "data": [
    {
      "id": "60541d4fd28931d5f9f617ff",
      "wxid": "1688853462929494",
      "weixin": "MiRenDeHaiYang",
      "nickName": "迷人的海洋",
      "avatar": "https://wework.qpic.cn/bizmail/wE1wZT8dKWr2jcpjCNC9fDXzjQKcq8CRew9cj4cog4nFDm9z6SibVFw/0",
      "online": true
    }
  ]
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
dataarray托管企业微信数据
data.idstring托管企业微信的账号ID
data.wxidstring托管企业微信的wxid,在企业微信内唯一
data.weixinstring托管企业微信的userId,可与企业微信API的userId一一对应
data.nickNamestring托管企业微信的昵称
data.avatarstring托管企业微信的头像
data.onlineboolean托管企业微信是否在线

获取个人微信授权到期及首次扫码登录的时间

GET https://hub.juzibot.com/api/v1/bot/weChatExpiredInfo

参数:

token, // 必选
id, 账号ID // 必选

参数需要通过url传入,例如:

GET https://hub.juzibot.com/api/v1/bot/weChatExpiredInfo?token={your-token}&id=**

返回数据为json格式,具体格式如下:

{
  "code": 0,
  "data": [
    {
      "id": "60541d4fd28931d5f9f617ff",
      "wxid": "1688853462929494",
      "weixin": "MiRenDeHaiYang",
      "nickName": "迷人的海洋",
      "expiredTimestamp": 1658764800000,
      "scanLoginTimestamp": 1658772000000
    }
  ]
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
dataarray微信授权到期及首次扫码登录数据
data.idstring托管企业微信的账号ID
data.wxidstring托管企业微信的wxid,在企业微信内唯一
data.weixinstring托管企业微信的userId,可与企业微信API的userId一一对应
data.nickNamestring托管企业微信的昵称
data.expiredTimestampnumber个人微信授权到期时间
data.scanLoginTimestampnumber首次扫码登录时间

获取联系人列表

GET https://ex-api.botorange.com/contact/list

此接口为分页接口,单页最大100条,需要自行翻页获取所有数据

参数:

token, // 必选
current, // 可选,默认为0,即第一页
pageSize, // 可选,默认为10,最大为100
wxid, // 可选,用来搜索某wxid的用户,当传入此参数时,current 和 pageSize 失效

参数需要通过url传入,例如:

GET https://ex-api.botorange.com/contact/list?token={your-token}&current=1&pageSize=4

上面这条请求会查询第5-8条数据,即每页四条,第二页的数据

GET https://ex-api.botorange.com/contact/list?wxid=wxid_xxxxx

上面这条请求会查询 wxid 为 wxid_xxxxx 的用户

返回数据为json格式,具体格式如下:

{
  "code": 0,
  "data": [
    {
      "chatId": "5dbe8287184b7cb41f5265ce",
      "botInfo": {
        "wxid": "wxid_rr9ej1o8xv9h21",
        "weixin": "iguxiaobei",
        "nickName": "小北"
      },
      "wxid": "wxid_rr9ej1o8xv9h20",
      "weixin": "kx930418",
      "nickName": "联系人昵称",
      "alias": "联系人备注",
      "avatarUrl": "http://wx.qlogo.cn/mmhead/ver_1/rIMjtIkM3fRnugJcOj9AA9BiaPpIWRia9SaxNPXMLMSj0zcBKIvboibaReOakDbicUzk3B24o87AXwSX4yibtFXicLiaA/132",
      "city": "Haidian",
      "province": "Beijing",
      "gender": 2,
      "labels": [
        {
          "id": "5eda03260e21f35ca20f9eb4",
          "name": "同事"
        }
      ],
      "contactType": 1,
      "coworker": false,
      "unionId": "xxxxxxx",
      "externalUserId": "xxxxxxxx",
      "deleted": false
    }
  ],
  "page": {
    "current": 1,
    "total": 428
  }
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
dataarray联系人数据
data.chatIdstring该联系人的对话ID
data.botInfoobject所属微信信息
data.botInfo.wxidstring所属微信的wxid
data.botInfo.weixinstring所属微信的userId,可与企业微信API的userId一一对应
data.botInfo.nickNamestring所属微信昵称
data.wxidstringwxid,该id在微信里唯一
data.weixinnumberuserId
data.nickNamestring昵称
data.aliasstring备注
data.avatarUrlstring头像
data.citystring的省份信息
data.provincestring的城市信息
data.gendernumber性别,0 - 未知,1 - 男,2 - 女
data.labelsarray秒回标签信息
data.labels.idarray秒回标签id
data.labels.namearray秒回标签名字
data.contactTypenumber联系人类型,0 - 未知,1 - 微信,2 - 公众号,3 - 企业微信
data.coworkerboolean是否为同事(同一个企业下的员工)
data.unionIdstring该联系人对应的unionId,该值只有在关联了企业控制台,此联系人数据在企业控制台和秒回间打通,并且当前企业微信的企业绑定了微信开放平台才可返回
data.deletedboolean是否已删除
data.externalUserIdstring该联系人对应的externalUserId,该值只有在关联了企业控制台,此联系人数据在企业控制台和秒回间打通才可返回

获取群列表

GET https://ex-api.botorange.com/room/list

此接口为分页接口,单页最大100条,需要自行翻页获取所有数据

参数:

token, // 必选
current, // 可选,默认为0,即第一页
pageSize, // 可选,默认为10,最大为100
wxid, // 可选,用来搜索某 wxid 的群,当传入此参数时,current 和 pageSize 失效

参数需要通过url传入,例如:

GET https://ex-api.botorange.com/room/list?token={your-token}&current=2&pageSize=5

上面这条请求会查询第11-15条数据,即每页五条,第三页的数据

GET https://ex-api.botorange.com/room/list?wxid=chatroom@xxx

上面这条请求会查询 wxid 为 chatroom@xxx 的群

返回数据为json格式,具体格式如下:

{
  "code": 0,
  "data": [
    {
      "chatId": "5dbe8287184b7cb41f52674e",
      "botInfo": {
        "wxid": "wxid_rr9ej1o8xv9h21",
        "weixin": "iguxiaobei",
        "nickName": "小北"
      },
      "wxid": "11293954269@chatroom",
      "topic": "大街小巷程序员",
      "avatarUrl": "http://wx.qlogo.cn/mmcrhead/WibBib8GYLV5M0UyNUyX4SA5zf5cCzOjsCG3Z1HWA1hneVfQfTIPygia6ibN31LSWqG1jFe0zXZSujPp4CwhBibXpxeQPnDp3LEYN/0",
      "ownerId": "wxid_rr9ej1o8xv9h21",
      "members": [
        {
          "wxid": "kx23498",
          "nickName": "群成员昵称",
          "avatarUrl": "http://wx.qlogo.cn/mmhead/ver_1/3mtHGNE50ZpxZX3SMwqibluNAz5GgiaAVLyzyc3Ex0TThpfrVUibnKiagiciaP5jeO2f6wYAuiaW5cXjKhsgbAHzCzNs4V4uibzLkxr0z3XaluTRGUc/132",
          "roomAlias": null,
          "isFriend": true,
          "contactType": 1,
          "coworker": false // is coworker or not
        }
      ],
      "labels": [
        {
          "id": "5eda03260e21f35ca20f9eb4",
          "name": "VIP客户群"
        }
      ],
      "wecomChatId": "wrrRhyBgAAGf2Wo90zgjmNspXj4y8pQA", // 如果需要该值, 需要联系售后申请内测升级
      "deleted": false,
      "external": true,
      "memberCount": 10
    }
  ],
  "page": {
    "current": 1,
    "total": 107
  }
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
dataarray群数据
data.chatIdstring该群组的对话id
data.botInfoobject所属微信信息
data.botInfo.wxidstring所属微信的wxid
data.botInfo.weixinstring所属微信的userId,可与企业微信API的userId一一对应
data.botInfo.nickNamestring所属微信昵称
data.wxidstringwxid,该id在微信里唯一
data.topicstring群名称
data.avatarUrlstring群头像
data.ownerIdstring群主wxid
data.membersarray群成员
data.members.wxidstring群成员wxid
data.members.nickNamestring群成员昵称
data.members.avatarUrlstring群成员头像url
data.members.roomAliasstring群成员在群中的昵称
data.members.isFriendboolean该成员是否和所属微信是好友
data.members.contactTypenumber联系人类型,0 - 未知,1 - 微信,2 - 公众号,3 - 企业微信
data.members.coworkerboolean是否为同事(同一个企业下的员工)
data.members.corporationstring该客户所属企业名
data.labelsarray秒回标签
data.labels.idstring秒回标签id
data.labels.namestring秒回标签名称
data.wecomChatIdstring企业微信群官方id。如果需要该值, 需要联系售后申请内测升级
data.deletedboolean群聊是否已经不在
data.externalboolean群聊 true外部群聊 false内部群聊
data.memberCountnumber群成员人数
pageobject分页信息
page.currentnumber当前页数
page.totalnumber总数

注:该接口于2021-04-13号增加了 contactTypecoworker 字段,但此数据需要系统重新同步才会存在 注2:该接口于2021-11-27号增加了 corporation 字段,但此数据需要系统重新同步才会存在 所以对于 2021-04-13 和 2021-11-27 之前存在的账号,如果需要返回此字段,需要手动在秒回后台的【客户管理】页面点击【同步群聊】按钮来同步数据,之后才可以获取到这两个新增字段

获取群列表(不包含成员信息)

GET https://ex-api.botorange.com/room/simpleList

此接口为分页接口,单页最大100条,需要自行翻页获取所有数据

参数:

token, // 必选
current, // 可选,默认为0,即第一页
pageSize, // 可选,默认为10,最大为100
wxid, // 可选,用来搜索某 wxid 的群,当传入此参数时,current 和 pageSize 失效

参数需要通过url传入,例如:

GET https://ex-api.botorange.com/room/simpleList?token={your-token}&current=2&pageSize=5

上面这条请求会查询第11-15条数据,即每页五条,第三页的数据

GET https://ex-api.botorange.com/room/simpleList?wxid=chatroom@xxx

上面这条请求会查询 wxid 为 chatroom@xxx 的群

返回数据为json格式,具体格式如下:

{
  "code": 0,
  "data": [
    {
      "chatId": "5dbe8287184b7cb41f52674e",
      "botInfo": {
        "wxid": "wxid_rr9ej1o8xv9h21",
        "weixin": "iguxiaobei",
        "nickName": "小北"
      },
      "wxid": "11293954269@chatroom",
      "topic": "大街小巷程序员",
      "avatarUrl": "http://wx.qlogo.cn/mmcrhead/WibBib8GYLV5M0UyNUyX4SA5zf5cCzOjsCG3Z1HWA1hneVfQfTIPygia6ibN31LSWqG1jFe0zXZSujPp4CwhBibXpxeQPnDp3LEYN/0",
      "ownerId": "wxid_rr9ej1o8xv9h21",
      "memberCount": 10,
      "labels": [
        {
          "id": "5eda03260e21f35ca20f9eb4",
          "name": "VIP客户群"
        }
      ],
      "wecomChatId": "wrrRhyBgAAGf2Wo90zgjmNspXj4y8pQA", // 如果需要该值, 需要联系售后申请内测升级
      "deleted": false,
      "external": true,
      "memberCount": 10
    }
  ],
  "page": {
    "current": 1,
    "total": 107
  }
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
dataarray群数据
data.chatIdstring该群组的对话id
data.botInfoobject所属微信信息
data.botInfo.wxidstring所属微信的wxid
data.botInfo.weixinstring所属微信的userId,可与企业微信API的userId一一对应
data.botInfo.nickNamestring所属微信昵称
data.wxidstringwxid,该id在微信里唯一
data.topicstring群名称
data.avatarUrlstring群头像
data.ownerIdstring群主wxid
data.memberCountint群成员数量
data.labelsarray秒回标签
data.labels.idstring秒回标签id
data.labels.namestring秒回标签名称
data.wecomChatIdstring企业微信群官方id。如果需要该值, 需要联系售后申请内测升级
data.deletedboolean群聊是否已经不在
data.externalboolean群聊 true外部群聊 false内部群聊
data.memberCountnumber群成员人数
pageobject分页信息
page.currentint当前页数
page.totalint总数

发送秒回通知

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

请求示例:

{
  "token": "5f60998462c907003e1fa2c1",
  "content": "通知内容",
  "title": "通知标题",
  "time": 30
}

请求参数:

名称类型是否必须备注
tokenstring秒回调用接口凭证
contentstring通知内容
titlestring通知标题,可以不存在
timenumber通知展示时长(单位秒), 如果为0或者不传则不会自动关闭

注意

小组成员登录秒回且网页端打开时,才会显示提醒。 刷新网页/关闭浏览器 会导致通知消息全部关闭。

返回示例:

{
  "code": 0
}

获取秒回标签列表

GET https://ex-api.botorange.com/tag/mh/list?token=***

请求参数:

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

返回示例:

{
  "code": 0,
  "data": [{
    "id": "tagId",
    "groupId": "groupId",
    "name": "tagName",
    "type": MHTagType,
  }]
}

返回参数说明:

参数类型必定存在备注
codenumber返回码
messagestring对返回码的文本描述内容
data.idstring秒回标签id
data.groupIdstring小组id
data.namestring秒回标签名称
data.typenumber秒回标签类型(MHTagType)
enum MHTagType {
  Contact = 0, // 联系人秒回标签
  Room = 1,    // 群聊秒回标签
}

获取组内员工列表

GET https://ex-api.botorange.com/user/list?token=***

请求参数:

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

返回示例:

{
  code: 0,
  data:[{
    id: '61a7e8beabdb43077460e32c'
    wecomUserId: 'zhangsan',
    name: '张三',
    email: 'zhangsan@163.com',
    phone: '123',
    avatar: 'http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0'
  }],
}
名称类型必定存在备注
codenumber返回码
data.idstring员工id
data.wecomUserIdstring员工企微userId
data.namestring员工姓名
data.emailstring员工邮箱
data.phonestring员工手机号
data.avatarstring员工头像
最近更新:
Contributors: windmemory