alipay.open.public.topic.create(营销位添加接口) 在线调试(沙箱环境)

开发者可以通过此接口,在生活号主页中配置营销位,支持展示4-8个营销位,满足商家对业务的需求,需要注意的是,当某个营销位需要显示为头图时,必须要配置以下三个参数:营销位描述 (sub_title)、营销位图片(img_url)、营销位链接地址(link_url),如不需要展示头图时,以上三个参数均不要传。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
title String 必选 10 营销位名称 营销位名称
sub_title String 可选 15 营销位描述。营销位需要展示头图时,必须填写该参数。 营销位描述
img_url String 可选 255 营销位图片url, 尺寸为996*450,最大不超过5M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url。营销位需要展示头图时,必须填写该参数。 https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx
link_url String 可选 255 营销位跳转地址,点击营销位头图跳到的链接url。营销位需要展示头图时,必须填写该参数。 https://www.alipay.com
link_type String 可选 20 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP HTTP
topic_items TopicItem[] 必选 营销位内容,数量限制:大于4个,小于8个
title String 必填 15 内容标题 内容标题
sub_title String 必填 8 内容说明 内容说明
img_url String 必填 255 内容图片url, 尺寸为300*300,最大不超过3M,支持格式:.jpg、.png ,请先调用 图片上传接口获得图片url https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx
link_url String 必填 255 跳转链接,点击营销位内容图片跳到的链接url https://www.alipay.com
link_type String 可选 20 跳转类型,网页:HTTP、小程序:APP,不传默认HTTP HTTP

响应参数

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

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicTopicCreateRequest request = new AlipayOpenPublicTopicCreateRequest();
request.setBizContent("{" +
"\"title\":\"营销位名称\"," +
"\"sub_title\":\"营销位描述\"," +
"\"img_url\":\"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx\"," +
"\"link_url\":\"https://www.alipay.com\"," +
"\"link_type\":\"HTTP\"," +
"      \"topic_items\":[{" +
"        \"title\":\"内容标题\"," +
"\"sub_title\":\"内容说明\"," +
"\"img_url\":\"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx\"," +
"\"link_url\":\"https://www.alipay.com\"," +
"\"link_type\":\"HTTP\"" +
"        }]" +
"  }");
AlipayOpenPublicTopicCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

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

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 请检查输入参数是否合法
TOPIC_SIZE_INVALID 营销位内容数量须为4-8个 请检查营销位内容个数是否符合要求
TOPIC_TITLE_INVALID 营销位标题格式不合法 请检查营销位标题是否合法
TOPIC_SHOW_IMG_PARAM_INVALID 展示头图时参数不合法 需要展示头图时,营销位描述、营销位图片url、跳转地址都必须填写。否则不需要展示头图时,请不要传其中任何一个参数。请检查是否正确
TOPIC_SUBTITLE_INVALID 营销位描述格式不合法 请检查营销位描述参数是否合法
TOPIC_IMGURL_INVALID 营销位图片URL格式不合法 请检查营销位图片URL是否合法
TOPIC_LINKURL_INVALID 营销位链接URL格式不合法 请检查一下营销位链接URL是否合法
TOPIC_ITEM_IMGURL_INVALID 营销位内容图片URL格式不合法 请检查营销位内容图片URL是否合法
TOPIC_ITEM_LINKURL_INVALID 营销位内容图片跳转链接URL格式不合法 请检查营销位内容图片跳转链接URL是否合法
TOPIC_ITEM_TITLE_INVALID 营销位内容标题格式不合法 请检查营销位内容标题格式是否合法
TOPIC_ITEM_SUBTITLE_INVALID 营销位内容描述格式不合法 请检查营销位内容描述是否合法
LIFE_APP_FILE_TOO_LARGE 生活号图片上传文件过大 请检查图片大小是否合法
PUBLIC_IMG_TYPE_INVALID 图片类型不正确, 建议格式: jpg、png 请检查图片类型是否正确,建议格式: jpg、png
TOPIC_EXISTS 营销位已经存在,请勿重复添加 营销位已经存在了,请调用营销位更新接口更新
BUSINESS_ERROR 系统业务处理错误 请检查输入参数是否正确,或者稍后重试
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
onlineServer