alipay.marketing.tool.fengdie.activity.query(查询H5应用详情) 在线调试(沙箱环境)

查询创建的H5应用的详细信息,如:应用标题、应用名称(url根据该名称拼接而成)、发布时间等。详情可见Activity的属性。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
activity_id Number 必选 11 H5应用的唯一id,调用alipay.marketing.tool.fengdie.activity.create获得 100

响应参数

参数 类型 是否必填 最大长度 描述 示例值
activity FengdieActivity 必填 H5应用详情
id Number 必填 11 H5应用的唯一id,调用alipay.marketing.tool.fengdie.activity.create接口时自动生成 100
name String 必填 100 创建的H5应用的名称,调用alipay.marketing.tool.fengdie.activity.create接口时作为参数传入,默认自动生成。最终显示在H5生成的URL上。URL规则为 "域名/p/f/${name}/index.html" christmas-2016
title String 必填 100 H5应用的标题,在唤起的H5编辑器中输入 圣诞节推广
status String 必填 40 H5应用被编辑的状态,如:OPEN:编辑中;COMPLETE:已完成;PRERELEASED:预览页面生成成功;PRERELEASE_FAIL:预览页面生成失败;RELEASED:已发布;RELEASE_FAIL:发布失败。在H5编辑器中点击保存、编辑完成、发布按钮时会触发。 OPEN
is_online Boolean 必填 10 应用是否已在线,在H5编辑器中点击发布按钮或者过了有效期会修改状态。如:true:在线,在设置的有效期内 ;false:已下线,超过了设置的有效期范围 false
publish_time Date 可选 100 H5应用最近一次发布时间,在H5编辑器中点击发布按钮时会修改 2016-01-13 14:53
offline_time Date 可选 100 H5应用下线时间,在H5编辑器中修改 2016-04-13 14:54
template_id Number 必填 100 创建H5应用所使用的模板包唯一id 100
nick_name String 必填 100 appid所属支付宝账号昵称 疯狂的小蚂蚁
page FengdieActivityPage[] 必填 100 唤起H5编辑器时默认展示的表单数据
id Number 必填 11 H5页面唯一id,创建H5应用时自动生成 1001
name String 必填 100 H5页面名称 index.html
title String 必填 100 H5页面中文标题 门店介绍首页
snapshot String 可选 500 H5页面预览图 https://zos.alipayobjects.com/rmsportal/oTXVNqguQzKpNWqqUCcX.png
url String 必填 500 H5页面访问地址 https://render.alipay.com/p/f/fd-igt6lid/index.html
schema FengdieActivitySchemaData[] 必填 5000 H5页面schema数据
name String 必填 100 指定需要初始化的schema区域,与模板中schema文件路径对应 schemas/all
data String 必填 5000 默认数据的内容,内容格式参考模板开发过程中自动生成的mock数据(与schema文件同名的json文件)。 {"image":"https://zos.alipayobjects.com/rmsportal/rlwtYjJzVWGXXhz.png","text":"文本框1111","richText":"富文本框","color":"#ff00ff"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingToolFengdieActivityQueryRequest request = new AlipayMarketingToolFengdieActivityQueryRequest();
request.setBizContent("{" +
"\"activity_id\":100" +
"  }");
AlipayMarketingToolFengdieActivityQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_tool_fengdie_activity_query_response": {
        "code": "10000",
        "msg": "Success",
        "activity": {
            "id": 100,
            "name": "christmas-2016",
            "title": "圣诞节推广",
            "status": "OPEN",
            "is_online": false,
            "publish_time": "2016-01-13 14:53",
            "offline_time": "2016-04-13 14:54",
            "template_id": 100,
            "nick_name": "疯狂的小蚂蚁",
            "page": [
                {
                    "id": 1001,
                    "name": "index.html",
                    "title": "门店介绍首页",
                    "snapshot": "https://zos.alipayobjects.com/rmsportal/oTXVNqguQzKpNWqqUCcX.png",
                    "url": "https://render.alipay.com/p/f/fd-igt6lid/index.html",
                    "schema": [
                        {
                            "name": "schemas/all",
                            "data": "{\"image\":\"https://zos.alipayobjects.com/rmsportal/rlwtYjJzVWGXXhz.png\",\"text\":\"文本框1111\",\"richText\":\"富文本框\",\"color\":\"#ff00ff\"}"
                        }
                    ]
                }
            ]
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ACTIVITY_NOT_EXIST H5页面不存在 请确认activity_id对应的H5页面是否存在,及是否有访问权限。
SYSTEM_ERROR 系统繁忙 系统异常,请重试。
onlineServer