alipay.open.public.message.custom.send(异步单发消息) 在线调试(沙箱环境)

异步单发消息

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
to_user_id String 必选 32 消息接收用户的userid 2088283746283746
msg_type String 可选 128 消息类型,text:文本消息,image-text:图文消息 text
articles Article[] 特殊可选 图文消息,当msg_type为image-text时,必须存在相对应的值
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 链接文字 查看详情
text Text 特殊可选 当msg_type为text时,必须设置相对应的值
content String 必填 256 文本消息的内容 你好
chat String 可选 4 是否是聊天消息。支持值:0,1,当值为0时,代表是非聊天消息,消息显示在生活号主页,当值为1时,代表是聊天消息,消息显示在咨询反馈列表页。默认值为0 0
event_type String 可选 10 触发消息的事件类型,默认为空。代表商户未改造。如果是follow,代表关注消息。click代表菜单点击,enter_ppchat代表进入事件;请注意事件类型的大小写 follow

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

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

响应示例

{
    "alipay_open_public_message_custom_send_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
PUBLIC_CHANNELS_CONFIG_INVAILD 服务窗商户已关闭第三方渠道配置 请打开第三方渠道配置
MSG_TYPE_ILLEGAL 消息类型非法 消息类型不能为空,请输入具体的消息类型
OPEN_ID_IS_ILLEGAL 请求的支付宝用户Id无效 请输入正确的支付宝用户id
MSG_SD_NOBEHAVIOR 用户没有行为,发送消息失败 用户没有发生消息的权限
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
MSG_SD_EVENT_TYPE_NOT_EXISTS 事件类型不存在,发送消息失败 查看接口文档,看event_type是否是文档里提到的事件类型。如果是follow,代表关注消息。click代表菜单点击,enter_ppchat代表进入事件;请注意事件类型的大小写
MSG_SD_FOLLOW_NOT_EXISTS 未关注,发送消息失败 如果发送的是关注事件消息,但用户却没有关注该生活号。关注事件类消息需要用户关注生活号才能发送。如果事件类型参数event_type是follow,代表关注消息。
MSG_SD_OVER_TIME 超过规定时间,发送消息失败 发送的事件消息,需要在规定的时间内发送完成。具体事件对应的规则follow事件、click事件,5分钟内可以发送,enter_ppchat一天只能发送一条。
MSG_ENTER_EVENT_OVER_LIMIT 进入事件发送频率超过限制,无法发送 进入事件发送频率是有频率控制,具体控制规则,目前线上进入事件一天只能发送一条。不排除后续规则有变化。如果有问题,可以咨询客服。
onlineServer