查询群聊数据统计-按群主聚合方式
通过客户群ID,获取详情。包括群名、群成员列表、群成员入群时间、入群方式。(客户群是由具有客户群使用权限的成员创建的外部群)
POST https://qw-openapi-tx.dustess.com/externalContact/v1/groupchat/statistic?accessToken=
Content-Type: application/json
字段 | 类型 | 描述 | 是否必须 |
---|---|---|---|
accessToken | String | accessToken | true |
请求参数名 | 类型 | 说明 | 是否必须 |
---|---|---|---|
day_begin_time | Int | 起始日期的时间戳,填当天的0时0分0秒(否则系统自动处理为当天的0分0秒)。取值范围:昨天至前180天。 | true |
day_end_time | Int | 结束日期的时间戳,填当天的0时0分0秒(否则系统自动处理为当天的0分0秒)。取值范围:昨天至前180天。如果不填,默认同 day_begin_time(即默认取一天的数据) | false |
owner_filter | Object | 群主过滤。如果不填,表示获取应用可见范围内全部群主的数据(但是不建议这么用,如果可见范围人数超过1000人,为了防止数据包过大,会报错 81017) | true |
owner_filter.userid_list | String[] | 群主ID(即尘锋员工id)列表, 与 企微群主ID列表 任选一, 当 企微群主ID列表 不为空时忽略此值 。最多100个 | true |
owner_filter.qw_userid_list | String[] | 群主ID(即企微员工id)列表。最多100个 | true |
order_by | Int | 排序方式。1 - 新增群的数量 2 - 群总数 3 - 新增群人数 4 - 群总人数 默认为1 | false |
order_asc | Int | 是否升序。0-否;1-是。默认降序 | false |
offset | Int | 分页,偏移量, 默认为0 | false |
limit | Int | 分页,预期请求的数据量,默认为500,取值范围 1 ~ 1000 | false |
{
"day_begin_time": 1600272000,
"day_end_time": 1600444800,
"owner_filter": {
"userid_list": [
"123"
],
"qw_userid_list": [
"zhangsan"
]
},
"order_by": 2,
"order_asc": 0,
"offset": 0,
"limit": 1000
}
响应参数名 | 类型 | 说明 |
---|---|---|
code | Int | 响应码 |
msg | String | 消息提示 |
success | Bool | 是否成功 |
data | Object[] | 返回数据 |
data.errcode | Int | 企微返回码 |
data.errmsg | String | 对返回码的文本描述内容 |
data.total | Int | 命中过滤条件的记录总个数 |
data.next_offset | Int | 当前分页的下一个offset。当next_offset和total相等时,说明已经取完所有 |
data.items | Object[] | 记录列表。表示某个群主所拥有的客户群的统计数据 |
data.items.owner | String | 群主ID(尘锋员工id) |
data.items.qw_userid | String | 企微员工id |
data.items.data | Object | 详情 |
data.items.data.new_chat_cnt | Int | 新增客户群数量 |
data.items.data.chat_total | Int | 截至当天客户群总数量 |
data.items.data.chat_has_msg | Int | 截至当天有发过消息的客户群数量 |
data.items.data.new_member_cnt | Int | 客户群新增群人数 |
data.items.data.member_total | Int | 截至当天客户群总人数 |
data.items.data.member_has_msg | Int | 截至当天有发过消息的群成员数 |
data.items.data.msg_total | Int | 截至当天客户群消息总数 |
data.items.data.migrate_trainee_chat_cnt | Int | 截至当天新增迁移群数(仅教培行业返回) |
{
"success": true,
"code": 0,
"msg": "OK",
"data": {
"errcode": 0,
"errmsg": "ok",
"total": 2,
"next_offset": 2,
"items": [
{
"owner": "123",
"qw_userid": "hangsan",
"data": {
"new_chat_cnt": 2,
"chat_total": 2,
"chat_has_msg": 0,
"new_member_cnt": 0,
"member_total": 6,
"member_has_msg": 0,
"msg_total": 0,
"migrate_trainee_chat_cnt": 3
}
}
]
}
}
修改于 2024-09-20 09:48:10