获取企业的全部群发记录

[TOC]

概述

企业跟第三方应用可通过该接口获取群发给客户的消息和群发到客户群的消息

群发助手和客户群群发有以下两种类型
企业发表
管理员或者业务负责人创建内容,成员确认后,即可发送给客户或者客户群
个人发表
成员自己创建的内容,可直接发送给客户或客户群

接口调用权限说明

  • 允许使用“客户联系”secret调用
  • 允许自建应用:使用配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
  • 允许第三方应用:第三方应用需授权企业客户权限群发消息给客户和客户群的权限

    第三方应用必须在服务商管理端申请“企业客户权限->客户联系->群发消息给客户和客户群”权限。
    对于历史已安装的企业,之前未授权该权限的,需要管理员去企业微信web管理端“应用管理->应用详情页->授权信息”中同意授权变更后才允许调用。

获取群发记录列表

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

请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_list_v2?access_token=ACCESS_TOKEN

请求示例:

{
   "chat_type":"single",
   "start_time":1605171726,
   "end_time":1605172726,
   "creator":"zhangshan",
   "filter_type":1,
   "limit":50,
   "cursor":"CURSOR"
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
chat_type 群发任务的类型,默认为single,表示发送给客户,group表示发送给客户群
start_time 群发任务记录开始时间
end_time 群发任务记录结束时间
creator 群发任务创建人企业账号id
filter_type 创建人类型。0:企业发表 1:个人发表 2:所有,包括个人创建以及企业创建,默认情况下为所有类型
limit 返回的最大记录数,整型,最大值100,默认值50,超过最大值时取默认值
cursor 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

补充说明:

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

权限说明:

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

返回结果:

{
    "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"
                    }
                }
            ]
        }
    ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
next_cursor 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空
group_msg_list 群发记录列表
group_msg_list.msgid 企业群发消息的id,可用于获取企业群发成员执行结果
group_msg_list.creator 群发消息创建者userid,API接口创建的群发消息不返回该字段
group_msg_list.create_time 创建时间
group_msg_list.create_type 群发消息创建来源。0:企业 1:个人
group_msg_list.text.content 消息文本内容,最多4000个字节
group_msg_list.attachments.msgtype 值必须是image
group_msg_list.attachments.image.media_id 图片的media_id,可以通过获取临时素材下载资源
group_msg_list.attachments.image.pic_url 图片的url,与图片的media_id不能共存优先吐出media_id
group_msg_list.attachments.msgtype 值必须是link
group_msg_list.attachments.link.title 图文消息标题
group_msg_list.attachments.link.picurl 图文消息封面的url
group_msg_list.attachments.link.desc 图文消息的描述,最多512个字节
group_msg_list.attachments.link.url 图文消息的链接
group_msg_list.attachments.msgtype 值必须是miniprogram
group_msg_list.attachments.miniprogram.title 小程序消息标题,最多64个字节
group_msg_list.attachments.miniprogram.appid 小程序appid,必须是关联到企业的小程序应用
group_msg_list.attachments.miniprogram.page 小程序page路径
group_msg_list.attachments.msgtype 值必须是video
group_msg_list.attachments.video.media_id 视频的media_id,可以通过获取临时素材下载资源

获取群发成员发送任务列表

请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_task?access_token=ACCESS_TOKEN

请求示例

{
    "msgid": "msgGCAAAXtWyujaWJHDDGi0mACAAAA",
    "limit":50,
    "cursor":"CURSOR "
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
msgid 群发消息的id,通过获取群发记录列表接口返回
limit 返回的最大记录数,整型,最大值1000,默认值500,超过最大值时取默认值
cursor 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

权限说明:

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

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "next_cursor":"CURSOR",
    "task_list": [
        {
            "userid": "zhangsan",
            "status": 1,
            "send_time": 1552536375
        }
    ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
next_cursor 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空
task_list 群发成员发送任务列表
task_list.userid 企业服务人员的userid
task_list.status 发送状态:0-未发送 2-已发送
task_list.send_time 发送时间,未发送时不返回

2020-11-17日之前创建的消息无发送任务列表,请通过获取企业群发成员执行结果接口获取群发结果

获取企业群发成员执行结果

请求方式:POST(HTTPS)

请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_send_result?access_token=ACCESS_TOKEN

请求示例

{
    "msgid": "msgGCAAAXtWyujaWJHDDGi0mACAAAA",
    "userid":"zhangsan ",
    "limit":50,
    "cursor":"CURSOR "
}

参数说明:

参数 必须 说明
access_token 调用接口凭证
msgid 群发消息的id,通过获取群发记录列表接口返回
userid 发送成员userid,通过获取群发成员发送任务列表接口返回
limit 返回的最大记录数,整型,最大值1000,默认值500,超过最大值时取默认值
cursor 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

权限说明:

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

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "next_cursor":"CURSOR",
    "send_list": [
        {
            "external_userid": "wmqfasd1e19278asdasAAAA",
            "chat_id":"wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
            "userid": "zhangsan",
            "status": 1,
            "send_time": 1552536375
        }
    ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
next_cursor 分页游标,再下次请求时填写以获取之后分页的记录,如果已经没有更多的数据则返回空
send_list 群成员发送结果列表
send_list.external_userid 外部联系人userid,群发消息到企业的客户群不返回该字段
send_list.chat_id 外部客户群id,群发消息到客户不返回该字段
send_list.userid 企业服务人员的userid
send_list.status 发送状态:0-未发送 1-已发送 2-因客户不是好友导致发送失败 3-因客户已经收到其他群发消息导致发送失败
send_list.send_time 发送时间,发送状态为1时返回

若为客户群群发,由于用户还未选择群,所以不返回未发送记录,只返回已发送记录
2020-11-17日之前创建的消息请通过获取企业群发成员执行结果接口获取群发结果

© 1998 - 2021 Tencent Inc. All Rights Reserved