alipay.open.public.message.group.send(分组消息发送接口) 在线调试(沙箱环境)

开发者可调用此接口向指定分组中的关注用户发送消息,该接口为异步接口,一般请求成功后一段时间用户才能收到消息。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.message.group.send
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
group_id String 必选 10 用户分组ID 10000
msg_type String 必选 32 消息类型,text表示文本消息,image-text表示图文消息 text
text Text 特殊可选 文本消息内容,当msg_type为text,必须设置该值,而且必须同时设置标题和内容字段
title String 必填 100 文本消息的标题 标题
content String 必填 256 文本消息的内容 你好
image Image 特殊可选 纯图片消息,暂时不支持,包含url信息,当msg_type为image时,必须设置该值 ,图片尺寸建议为1080x750px,小于3M,图片支持jpg、png格式
url String 必填 100 图片url,请先调用alipay.offline.material.image.upload 图片上传接口获得图片url http://example.com/abc.jpg
articles Article[] 特殊可选 图文消息,当msg_type为image-text,该值必须设置,图文消息中的图片建议尺寸 750 x 350px,小于3M,图片支持jpg、png格式
title String 可选 100 图文消息标题 图文消息标题
desc String 必填 512 图文消息内容 图文消息内容
image_url String 特殊可选 100 图片链接,对于多条图文消息的第一条消息,该字段不能为空; 请先调用 图片上传接口获得图片url http: //example.com/abc.jpg
url String 必填 100 点击图文消息跳转的链接 https://www.example.com/b.php
action_name String 可选 64 链接文字 查看详情

响应参数

参数 类型 是否必填 最大长度 描述 示例值
message_id String 必填 128 2013121100055554f1000b64-3f05-4581-a5e1-16e29d242950 消息ID

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicMessageGroupSendRequest request = new AlipayOpenPublicMessageGroupSendRequest();
request.setBizContent("{" +
"\"group_id\":\"10000\"," +
"\"msg_type\":\"text\"," +
"\"text\":{" +
"\"title\":\"标题\"," +
"\"content\":\"你好\"" +
"    }," +
"\"image\":{" +
"\"url\":\"http://example.com/abc.jpg\"" +
"    }," +
"      \"articles\":[{" +
"        \"title\":\"图文消息标题\"," +
"\"desc\":\"图文消息内容\"," +
"\"image_url\":\"http: //example.com/abc.jpg\"," +
"\"url\":\"https://www.example.com/b.php\"," +
"\"action_name\":\"查看详情\"" +
"        }]" +
"  }");
AlipayOpenPublicMessageGroupSendResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_message_group_send_response": {
        "code": "10000",
        "msg": "Success",
        "message_id": "消息ID"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 重试
GROUP_EMPTY_ERROR 人群为空 修改分组规则,保证圈定的人群不为空
ILLEGAL_BIZ_PARAMS 消息内容不合法 消息参数不合法,检查消息
MSG_BATCH_SD_OVER 消息发送频率超过限制 等消息发送额度恢复时,再重新发送
MSG_SEND_ILLEGAL 消息内容包含敏感词 修改内容,去除其中的敏感词
IMAGE_SIZE_ERROR 图片宽度和高度不符合要求 图片尺寸不符合规格
IMAGE_TOO_LARGE 图片大小超过限制 图片大小不能超过3M
ILLEGAL_IMAGE_FORMAT 图片格式不合法 检查图片格式,目前只支持jpg和png
MESSAGE_IS_EMPTY 消息内容为空 保证消息内容不为空
MESSAGE_IS_INCOMPLETE 消息内容不完整 检查不同消息类型的消息内容字段是否填充完整
onlineServer