# 获取群发任务详情
请求方式: GET(HTTPS)
请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-groupmsg/v1/groupmsg/get
请求参数说明:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
groupmsg_id | string | 是 | 群发 id |
请求示例:
https://nbd-api.myscrm.cn/open-nbd-qw-groupmsg/v1/groupmsg/get?groupmsg_id=xxxx
返回数据:
{
"errcode": 0,
"errmsg": "ok",
"groupmsg_id": "3a007784-085e-2039-4c86-6261fe641d20",
"app_id": "39fdf97b-2bc3-010d-82cd-e12d78b15714",
"proj_list": [
{
"organ_proj_id": "345",
"organ_proj_name": "123"
},
{
"organ_proj_id": "8496",
"organ_proj_name": "2g42"
}
],
"custom_condition": [
{
"code": "sdaf",
"values": "brew,nte"
},
{
"code": "489",
"values": "g432g"
}
],
"msg_name": "123",
"msg_text": "456789",
"customer_filter_type": 1,
"customer_tag_rule": 1,
"groupmsg_employee_list": [
{
"qw_user_id": "godfrey",
"qw_user_name": "godfrey"
}
],
"corp_tags": ["456"],
"qw_external_userids": ["wm-TUtCAAAdw4KNTqJJUttqJda9K5vdg"],
"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",
"chat_type": "single",
"creator_id": "string",
"creator_name": "string"
}
返回参数说明:
名称 | 类型 | 说明 |
---|---|---|
groupmsg_id | string | 群发 id |
app_id | string | 企微中台应用 id |
proj_list | array | 项目列表 |
proj_list.organ_proj_id | string | 项目 id 为空表示全局 |
proj_list.organ_proj_name | string | 项目名称 项目 id 不为空时必填 |
custom_condition | array | 自定义条件 |
custom_condition.code | string | 条件编码 |
custom_condition.values | string | 条件值,多个逗号分割 |
msg_name | string | 消息名称 |
msg_text | string | 消息文本 |
customer_filter_type | int32 | 客户筛选类型:1-按条件筛选,2-全部客户 |
customer_tag_rule | int32 | 标签规则类型:1-任意满足,2-所有满足,3-不包含 |
groupmsg_employee_list | array | 关联员工的企微用户 |
groupmsg_employee_list.qw_user_id | string | 企微成员 id |
groupmsg_employee_list.qw_user_name | string | 企微成员姓名 |
corp_tags | string[] | 群发客户标签 id 列表 |
qw_external_userids | string[] | 企微客户 id 列表 |
groupmsg_attachment_list | array | 消息附件 |
groupmsg_attachment_list.type | int32 | 附件类型:1-图片,2-小程序,3-H5,4-视频,5-文件 |
groupmsg_attachment_list.img_url | string | 图片 URL |
groupmsg_attachment_list.h5_href | string | h5 链接 |
groupmsg_attachment_list.h5_title | string | h5 标题 |
groupmsg_attachment_list.h5_description | string | h5 描述 |
groupmsg_attachment_list.h5_cover_url | string | h5 封面 |
groupmsg_attachment_list.video_url | string | 视频 url |
groupmsg_attachment_list.file_url | string | 文件 url |
groupmsg_attachment_list.is_custom_miniprogram | bool | 是否自定义小程序 |
groupmsg_attachment_list.miniprogram_title | string | 小程序标题 |
groupmsg_attachment_list.miniprogram_appid | string | 小程序 appid |
groupmsg_attachment_list.miniprogram_page_group | string | 选择已有小程序时的页面分类 |
groupmsg_attachment_list.miniprogram_page_name | string | 选择已有小程序时的页面名称 |
groupmsg_attachment_list.miniprogram_url | string | 小程序路径 |
groupmsg_attachment_list.miniprogram_pic_url | string | 小程序封面 url |
qw_msg_id | string | 企微消息 ID(2022.3.15 后废弃,将不再返回) |
status | int32 | 状态:1-待发送,2-发送失败,3-发送中,4-已发送 |
send_time | string | 发送给成员的时间: yyyy-mm-dd hh:ii:ss |
create_at | string | 创建时间: yyyy-mm-dd hh:ii:ss |
modify_at | string | 修改时间: yyyy-mm-dd hh:ii:ss |
chat_type | string | 群发任务类型:single-单聊(默认),group-客户群 |
creator_id | string | 创建人 id |
creator_name | string | 创建人名称 |
create_source | int32 | 创建来源:1-企业创建,2-个人创建 |
creator_type | int32 | 创建人类型:1-后台登录用户id,2-企微成员id |