文档中心 > API类目 > 生活号(原服务窗)API

alipay.open.public.message.single.send (单发模板消息)

单发模板消息

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.message.single.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 256 商户请求参数的签名串,详见签名 详见示例
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 2088202882050410
template Template 可选 - 消息模板相关参数,其中包括templateId模板ID和context模板上下文
  • └ template_id
  • String
  • 必填
  • 128
  • 消息模板ID
  • cbb9fdded2b74fe4bb082de3ed1e1eb2
  • context
  • Context
  • 必填
  • 4096
  • 消息模板上下文,即模板中定义的参数及参数值
  • └ head_color
  • String
  • 必填
  • 10
  • 顶部色条的色值
  • #85be53
  • └ url
  • String
  • 必填
  • 256
  • 点击消息后承接页的地址
  • http://m.baidu.com
  • └ action_name
  • String
  • 必填
  • 32
  • 底部链接描述文字,如“查看详情”
  • 查看详情
  • keyword1
  • Keyword
  • 可选
  • 256
  • 模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色
  • └ color
  • String
  • 必填
  • 10
  • 当前文字颜色
  • #85be53
  • └ value
  • String
  • 必填
  • 128
  • 模板中占位符的值
  • HU7142
  • keyword2
  • Keyword
  • 可选
  • 256
  • 模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色
  • └ color
  • String
  • 必填
  • 10
  • 当前文字颜色
  • #85be53
  • └ value
  • String
  • 必填
  • 128
  • 模板中占位符的值
  • HU7142
  • first
  • Keyword
  • 可选
  • 256
  • 模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色
  • └ color
  • String
  • 必填
  • 10
  • 当前文字颜色
  • #85be53
  • └ value
  • String
  • 必填
  • 128
  • 模板中占位符的值
  • HU7142
  • remark
  • Keyword
  • 可选
  • 256
  • 模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色
  • └ color
  • String
  • 必填
  • 10
  • 当前文字颜色
  • #85be53
  • └ value
  • String
  • 必填
  • 128
  • 模板中占位符的值
  • HU7142

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicMessageSingleSendRequest request = new AlipayOpenPublicMessageSingleSendRequest();
request.setBizContent("{" +
"\"to_user_id\":\"2088202882050410\"," +
"\"template\":{" +
"\"template_id\":\"cbb9fdded2b74fe4bb082de3ed1e1eb2\"," +
"\"context\":{" +
"\"head_color\":\"#85be53\"," +
"\"url\":\"http://m.baidu.com\"," +
"\"action_name\":\"查看详情\"," +
"\"keyword1\":{" +
"\"color\":\"#85be53\"," +
"\"value\":\"HU7142\"" +
"        }," +
"\"keyword2\":{" +
"\"color\":\"#85be53\"," +
"\"value\":\"HU7142\"" +
"        }," +
"\"first\":{" +
"\"color\":\"#85be53\"," +
"\"value\":\"HU7142\"" +
"        }," +
"\"remark\":{" +
"\"color\":\"#85be53\"," +
"\"value\":\"HU7142\"" +
"        }" +
"      }" +
"    }" +
"  }");
AlipayOpenPublicMessageSingleSendResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_open_public_message_single_send_response":{
		"msg":"Success",
		"code":"10000"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
MSG_TEMPLATE_INVALID 无效的消息模板内容template!!! 请输入正确的消息的模板内容
MSG_TEMPLATE_ID_INVALID 无效的消息模板标识templateId!!! 输入正确的消息模板标识
MSG_TEMPLATE_KEY_INVALID 无效的消息模板KEY,和预设变量KEY冲突!!! 请输入正确的消息模板KEY
OPENID_INVALID 无效的userId!!! 请输入正确的支付宝账号id
MSG_TEMPLATE_NOT_EXIST 消息模板不存在 请输入存在的消息模板
MSG_TEMPLATE_NOT_STARTED 消息模板未启用 请输入启用的消息模板
MSG_TEMPLATE_CONTEXT_LACK_KEY 模板上下文context缺少相关的变量KEY!!! 请确保模板上下文参数输入正确
ILLEGAL_ARGUMENT_PARAMS 无效的参数 请输入正确的参数
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试

公共错误码

返回
顶部