alipay.open.public.message.query(生活号查询已发送消息接口) 在线调试(沙箱环境)

填入发送的消息id集,查询消息的发送时间、状态、内容,支持isv调用

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.message.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
message_ids String[] 必选 64 消息id集,限制最多传入20个message_id。message_id在调用群发、组发消息接口时会返回,需调用方保存 2017080301329810fa9f7ca2-4634-481b-bca2-54092fd4be72

响应参数

参数 类型 是否必填 最大长度 描述 示例值
list PublicMessageInfo 选填 发送消息结果集。仅返回该用户已发送的消息
send_time String 必填 64 消息发送时间 2017-07-27 15:34:19
message_id String 必填 64 消息id 2017071800094212ff1c12e2-267e-425e-9880-653598f0bb59
status String 必填 32 发送状态。INIT:未开始发送、RUNNING:发送中、SUCCESS:发送成功、FAILURE:发送失败、RECALLING:撤回中、RECALLED:撤回失败 SUCCESS
status_desc String 必填 32 消息状态:未开始发送、发送失败、正在处理中、撤回中、撤回成功、发送成功 发送成功

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicMessageQueryRequest request = new AlipayOpenPublicMessageQueryRequest();
request.setBizContent("{" +
"\"message_ids\":[" +
"\"2017080301329810fa9f7ca2-4634-481b-bca2-54092fd4be72\"" +
"]" +
"}");
AlipayOpenPublicMessageQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_message_query_response": {
        "code": "10000",
        "msg": "Success",
        "list": [
            {
                "send_time": "2017-07-27 15:34:19",
                "message_id": "2017071800094212ff1c12e2-267e-425e-9880-653598f0bb59",
                "status": "SUCCESS",
                "status_desc": "发送成功"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_open_public_message_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后再试
ILLEGAL_BIZ_PARAMS 业务参数错误 请检查message_ids是否填写
MESSAGE_QUERY_ID_EMPTY 消息查询id为空 请检查message_ids是否填写
MESSAGE_QUERY_OVER_LIMIT 消息id查询数量超限 消息id集限制为20个,请检查message_ids传入的个数
MESSAGE_QUERY_ID_TOO_LONG 消息id长度过长 消息id长度限制64,请检查是否正确
onlineServer