小程序
取消
开发
中文
EN
取消
  • 服务端

    • # 消息效果数据

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

    接口英文名：getRetailMessageList

    该接口用于获取发送的消息数据。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxa/business/getretailmessagelist?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用。

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：158

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String Parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    startnumber是分页起始位置，从0开始计数，用于分页查询，默认值为0
    offsetnumber是每页返回的数据条数上限，最大值为1000，默认值为20
    begin_datestring是开始时间，格式为“xxxx-yy-zz”的字符串，例如：“2024-08-01”
    end_datestring是结束时间，格式为“xxxx-yy-zz”的字符串，例如：“2024-08-10”

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    total_numnumber查询到数据总数
    data_lineobjarray数据列表

    # Res.data_line(Array) Object Payload

    数据列表

    参数名类型说明
    msg_idnumber消息id
    msg_typenumber消息类型
    datestring消息日期
    msg_timestring消息发送时间
    send_uvnumber发送人数
    entry_uvnumber进入人数
    business_msg_idstring自定义msg_id

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {
  "start": 0,
  "offset": 100,
  "begin_date": "2024-08-10",
  "end_date": "2024-08-15"
}

    返回示例

    {
    "errcode": 0,
    "errmsg": "ok",
    "total_num": 2,
    "data_line": [
        {
            "msg_id": 2,
            "msg_type": 11,
            "date": "2024-08-13",
            "msg_time": "2024-08-13 20:55:37",
            "send_uv": 1,
            "entry_uv": 1,
            "business_msg_id": "XXX"
        },
        {
            "msg_id": 1,
            "msg_type": 11,
            "date": "2024-08-13",
            "msg_time": "2024-08-13 20:01:15",
            "send_uv": 2,
            "entry_uv": 1,
            "business_msg_id": "XXX"
        }
    ]
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述
    -1系统错误
    0成功
    40079日期格式错误
    45165offset格式错误或超过最大限制

    # 7. 适用范围

    本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。