群聊管理接口
获取群列表
GET https://hub.juzibot.com/api/v1/groupChat/list?token=*¤t=*&pageSize=*
请求参数:
名称 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证 获取方式 |
current | string | 是 | 当前页数 |
pageSize | string | 是 | 每页数据条数 |
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
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data.chatId | string | 是 | 客户群ID, 详见wecomChatId |
data.name | string | 是 | 群名 |
data.owner | string | 是 | 群主ID |
data.createTime | number | 是 | 群的创建时间 |
data.notice | string | 否 | 群公告 |
data.memberList.userid | string | 是 | 群成员id, 详见externalUserId |
data.memberList.type | string | 是 | 成员类型。1 - 企业成员, 2 - 外部联系人 |
data.memberList.joinTime | number | 是 | 入群时间 |
data.memberList.joinScene | number | 是 | 入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群 |
获取群信息
POST https://hub.juzibot.com/api/v1/groupChat/get?token=*
请求参数:
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
}
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data.chatId | string | 是 | 客户群ID, 详见wecomChatId |
data.name | string | 是 | 群名 |
data.owner | string | 是 | 群主ID |
data.createTime | number | 是 | 群的创建时间 |
data.notice | string | 否 | 群公告 |
data.memberList.userid | string | 是 | 群成员id, 详见externalUserId |
data.memberList.type | string | 是 | 成员类型。1 - 企业成员, 2 - 外部联系人 |
data.memberList.joinTime | number | 是 | 入群时间 |
data.memberList.joinScene | number | 是 | 入群方式。1 - 由成员邀请入群(直接邀请入群, 2 - 由成员邀请入群(通过邀请链接入群), 3 - 通过扫描群二维码入群 |
绑定企业控制台ID
POST https://hub.juzibot.com/api/v1/groupChat/bindWxId?token=*
请求参数:
请求示例:
{
"jkbChatId": "worRhyBgAAO1az2jnN1xa44DIliYPetQ",
"wxId": "R:10696051011030627"
}
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
错误码 | 说明 |
---|
-1 | 根据token找不到有效的corp |
404 | wxId没有找到 |
500 | 调用存储过程中失败 |
wecomChatId转换wxid
请示地址:
GET https://hub.juzibot.com/api/v1/groupChat/wecomChatId_to_wxid?token=***&wecomChatId=wrrRhyBgAAOKVhkUa58GCFILSFRJqqqq
参数说明:
参数 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证 获取方式 |
wecomChatId | string | 是 | 群聊的企微chatId, 详见wecomChatId |
返回示例:
{
errcode: 0,
errmsg: "ok",
wxid: "R:10696052717016666"
}
参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
wxid | string | 是 | 客户的wxid, 详见roomWxid |
wxid转换wecomChatId
请示地址:
GET https://hub.juzibot.com/api/v1/groupChat/wxid_to_wecomChatId?token=***&wxid=R:10696052717016666
参数说明:
参数 | 类型 | 是否必须 | 备注 |
---|
token | string | 是 | 调用接口凭证 获取方式 |
wxid | string | 是 | 群聊的wxid, 详见roomWxid |
返回示例:
{
errcode: 0,
errmsg: "ok",
wecomChatId: "wrrRhyBgAAOKVhkUa58GCFILSFRJqqqq"
}
参数说明:
参数 | 类型 | 必定存在 | 备注 |
---|
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
wecomChatId | string | 是 | 群聊的企微chatId, 详见wecomChatId |