koubei.marketing.data.message.deliver (一键营销商家中心PUSH消息接口)

一键营销商家中心PUSH消息接口

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
msg_type String 必须 128 消息业务类型
活动推荐消息:PROMO_RECOMMEND;
活动效果消息: PROMO_STAT
PROMO_RECOMMEND
content String 必须 512 消息内容,json格式, KEY值编号递增 {"KEY1":"val1","KEY2":"val2","KEY3":"val3"}
ext_info String 可选 512 扩展信息, json格式,
key值:
REDIRECT_URL跳转地址;
CHANNEL发送渠道,对应value值为:MSGBOX消息盒子,PUSH手机消息通知
{"REDIRECT_URL":"https://e.alipay.com","CHANNEL":"MSGBOX"}

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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");
KoubeiMarketingDataMessageDeliverRequest request = new KoubeiMarketingDataMessageDeliverRequest();
request.setBizContent("{" +
"\"msg_type\":\"PROMO_RECOMMEND\"," +
"\"content\":\"{\\\"KEY1\\\":\\\"val1\\\",\\\"KEY2\\\":\\\"val2\\\",\\\"KEY3\\\":\\\"val3\\\"}\"," +
"\"ext_info\":\"{\\\"REDIRECT_URL\\\":\\\"https://e.alipay.com\\\",\\\"CHANNEL\\\":\\\"MSGBOX\\\"}\"" +
"}");
KoubeiMarketingDataMessageDeliverResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

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

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 稍后重试
INVALID_PARAMETER 参数有误 例如:消息业务类型msg_type非法,调整参数重试
ACCESS_ILLEGAL 无权访问 ISV不在白名单中

公共错误码

返回
顶部