获取企业的全部群发记录-获取群发记录列表

POST

/cgi-bin/externalcontact/get_groupmsg_list_v2

服务端API第三方应用开发企业内部开发

企业和第三方应用可通过此接口获取企业与成员的群发记录。

补充说明:

群发任务记录的起止时间间隔不能超过1个月
3.1.6版本之前不支持多附件，请参考获取群发记录列表接口获取群发记录列表

权限说明：

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
自建应用调用，只会返回应用可见范围内用户的发送情况。
第三方应用调用需要企业授权客户联系下群发消息给客户和客户群的权限

文档ID: 25429
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/93439
https://open.work.weixin.qq.com/api/doc/90000/90135/93338

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_list_v2?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"chat_type":"single","start_time":1605171726,"end_time":1605172726,"creator":"zhangshan","filter_type":1,"limit":50,"cursor":"CURSOR"}'

响应示例

{
    "errcode": 0,
    "errmsg": "ok",
    "next_cursor": "CURSOR",
    "group_msg_list": [
        {
            "msgid": "msgGCAAAXtWyujaWJHDDGi0mAAAA",
            "creator": "xxxx",
            "create_time": "xxxx",
            "create_type": 1,
            "text": {
                "content": "文本消息内容"
            },
            "attachments": [
                {
                    "msgtype": "image",
                    "image": {
                        "media_id": "MEDIA_ID",
                        "pic_url": "http://p.qpic.cn/pic_wework/3474110808/7a6344sdadfwehe42060/0"
                    }
                },
                {
                    "msgtype": "link",
                    "link": {
                        "title": "消息标题",
                        "picurl": "https://example.pic.com/path",
                        "desc": "消息描述",
                        "url": "https://example.link.com/path"
                    }
                },
                {
                    "msgtype": "miniprogram",
                    "miniprogram": {
                        "title": "消息标题",
                        "pic_media_id": "MEDIA_ID",
                        "appid": "wx8bd80126147dfAAA",
                        "page": "/path/index.html"
                    }
                },
                {
                    "msgtype": "video",
                    "video": {
                        "media_id": "MEDIA_ID"
                    }
                },
                {
                    "msgtype": "file",
                    "file": {
                        "media_id": "MEDIA_ID"
                    }
                }
            ]
        }
    ]
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

chat_type

string

必需

群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群

cursor

string

可选

用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填

start_time

integer <int32>

必需

群发任务记录开始时间

creator

string

可选

群发任务创建人企业账号id

filter_type

integer <int32>

可选

创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型

end_time

integer <int32>

必需

群发任务记录结束时间

limit

integer <int32>

可选

返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

next_cursor

string

可选

分页游标，再下次请求时填写以获取之后分页的记录，如果已经没有更多的数据则返回空

errmsg

string

可选

对返回码的文本描述内容

group_msg_list

array [object {6}]

群发记录列表

可选

creator

string

可选

群发消息创建者userid，API接口创建的群发消息不返回该字段

attachments

array [object {6}]

可选

create_time

string

创建时间

可选

msgid

string

可选

企业群发消息的id，可用于获取企业群发成员执行结果

create_type

integer <int32>

可选

群发消息创建来源。0：企业 1：个人

text

object

可选

修改于 2022-01-14 04:25:42

概述

获取企业的全部群发记录-获取群发成员发送任务列表