群聊管理接口

获取群列表

GET https://hub.juzibot.com/api/v1/groupChat/list?token=*&current=*&pageSize=*

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
currentstring当前页数
pageSizestring每页数据条数

TIP

该API支持批量拉取群信息,最大pageSize为100

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data":[{
    "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
    "name": "群名称",
    "owner": "owner",
    "createTime": 1532336327,
    "notice": "群公告",
    "memberList": [{
      "type": 1,
      "userId": "userId",
      "joinTime": 1605001966,
      "joinScene": 1
    }, {
      "type": 2,
      "userId": "externalUserId",
      "joinTime": 1605001977,
      "joinScene": 1
    }]
  }],
  "total": 10
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
data.chatIdstring客户群ID
data.namestring群名
data.ownerstring群主ID
data.createTimenumber群的创建时间
data.noticestring群公告
data.memberList.useridstring群成员id
data.memberList.typestring成员类型。1 - 企业成员, 2 - 外部联系人
data.memberList.joinTimenumber入群时间
data.memberList.joinScenenumber入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群

获取群信息

POST https://hub.juzibot.com/api/v1/groupChat/get?token=*

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
groupChatIdsarray群聊id列表

TIP

该API支持批量拉取群信息,groupChatIds的数组长度最大为100

返回示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data":[{
    "chatId": "wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ",
    "name": "群名称",
    "owner": "owner",
    "createTime": 1532336327,
    "notice": "群公告",
    "memberList": [{
      "type": 1,
      "userId": "userId",
      "joinTime": 1605001966,
      "joinScene": 1
    }, {
      "type": 2,
      "userId": "externalUserId",
      "joinTime": 1605001977,
      "joinScene": 1
    }]
  }],
  "total": 10
}

返回参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
data.chatIdstring客户群ID
data.namestring群名
data.ownerstring群主ID
data.createTimenumber群的创建时间
data.noticestring群公告
data.memberList.useridstring群成员id
data.memberList.typestring成员类型。1 - 企业成员, 2 - 外部联系人
data.memberList.joinTimenumber入群时间
data.memberList.joinScenenumber入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群

绑定企业控制台ID

POST https://hub.juzibot.com/api/v1/groupChat/bindWxId?token=*

请求参数:

名称类型是否必须备注
tokenstring调用接口凭证
jkbChatIdstring企业控制台ID
wxIdstring微信群官方ID

请求示例:

{
  "jkbChatId": "worRhyBgAAO1az2jnN1xa44DIliYPetQ",
  "wxId": "R:10696051011030627"
}

返回示例:

{
  "errcode": 0,
  "errmsg": "ok"
}
错误码说明
-1根据token找不到有效的corp
404wxId没有找到
500调用存储过程中失败

wecomChatId转换wxid

请示地址:

GET https://hub.juzibot.com/api/v1/groupChat/wecomChatId_to_wxid?token=***&wecomChatId=wrrRhyBgAAOKVhkUa58GCFILSFRJqqqq

参数说明:

参数类型是否必须备注
wecomChatIdstring群聊的企微chatId

返回示例:

{
  errcode: 0,
  errmsg: "ok",
  wxid: "R:10696052717016666"
}

参数说明:

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

wxid转换wecomChatId

请示地址:

GET https://hub.juzibot.com/api/v1/groupChat/wxid_to_wecomChatId?token=***&wxid=R:10696052717016666

参数说明:

参数类型是否必须备注
wxidstring群聊的wxid

返回示例:

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

参数说明:

参数类型必定存在备注
errcodenumber返回码
errmsgstring对返回码的文本描述内容
wecomChatIdstring群聊的企微chatId
最近更新:
Contributors: windmemory