# 获取群发任务列表
请求方式: POST(HTTPS)
请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-groupmsg/v1/groupmsg/list
请求参数说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
app_id | string | 是 | 企微应用 id |
organ_proj_id | string[] | 否 | 项目 id 列表 |
keyword | string | 否 | 关键字搜索 |
status | int32 | 否 | 发送状态:0-全部,1-待发送,2-发送失败,3-发送中,4-已发送,5-已停止 |
start_time | string | 否 | 群发发送起始时间: yyyy-mm-dd hh:ii:ss |
end_time | string | 否 | 群发发送结束时间: yyyy-mm-dd hh:ii:ss |
is_draft | bool | 否 | 是否是草稿 |
create_start_time | string | 否 | 创建起始时间: yyyy-mm-dd hh:ii:ss |
create_end_time | string | 否 | 创建结束时间: yyyy-mm-dd hh:ii:ss |
chat_type | string | 否 | 列表类型:single-单聊(默认),group-客户群 |
creator_name | string | 否 | 创建人名称(模糊匹配) |
pager | object | 否 | 分页信息 |
pager.page | int64 | 否 | 页码 |
pager.page_size | int64 | 否 | 分页行数 |
请求示例:
{
"app_id": "39fdf97b-2bc3-010d-82cd-e12d78b15714",
"organ_proj_id": ["345"],
"keyword": "",
"pager": {
"page": 1,
"page_size": 10
}
}
返回数据:
{
"errcode": 0,
"errmsg": "ok",
"groupmsg_list": [
{
"groupmsg_id": "3a007784-085e-2039-4c86-6261fe641d20",
"msg_name": "123",
"proj_list": [
{
"organ_proj_id": "345",
"organ_proj_name": "123"
},
{
"organ_proj_id": "8496",
"organ_proj_name": "2g42"
}
],
"status": 1,
"send_time": "2021-11-28 14:59:13",
"create_at": "2021-11-28 14:59:13",
"modify_at": "2021-11-28 14:59:13"
}
],
"pager": {
"page": "1",
"page_size": "10",
"total_rows": "1"
}
}
返回参数说明:
名称 | 类型 | 说明 |
---|---|---|
groupmsg_list | array | 列表 |
groupmsg_list.groupmsg_id | string | 群发 id |
groupmsg_list.msg_name | string | 消息名称 |
groupmsg_list.proj_list | array | 项目列表 |
groupmsg_list.proj_list.organ_proj_id | string | 项目 id |
groupmsg_list.proj_list.organ_proj_name | string | 项目名称 |
groupmsg_list.employee_count | int64 | 总成员数 |
groupmsg_list.employee_confirm_count | int64 | 已确认成员数 |
groupmsg_list.customer_count | int64 | 总客户数 |
groupmsg_list.customer_send_count | int64 | 已发送成员数 |
groupmsg_list.status | int32 | 状态:0-草稿,1-待发送,2-发送失败,3-发送中,4-已发送,5-已停止 |
groupmsg_list.send_time | string | 发送给成员的时间: yyyy-mm-dd hh:ii:ss |
groupmsg_list.create_at | string | 创建时间: yyyy-mm-dd hh:ii:ss |
groupmsg_list.modify_at | string | 修改时间: yyyy-mm-dd hh:ii:ss |
groupmsg_list.is_send_delayed | bool | 是否定时发送 |
groupmsg_list.send_schedule_time | string | 定时发送时间 时间格式: yyyy-mm-dd hh:ii:ss |
groupmsg_list.creator_id | string | 创建人 id |
groupmsg_list.creator_name | string | 创建人名称 |
groupmsg_list.create_source | int32 | 创建来源:1-企业创建,2-个人创建 |
groupmsg_list.creator_type | int32 | 创建人类型:1-后台登录用户id,2-企微成员id |
pager | object | 分页信息 |
pager.page | string | 页码 |
pager.page_size | string | 分页行数 |
pager.total_rows | string | 总行数 |