文档中心 > API类目 > 开放生态API

koubei.craftsman.data.work.batchquery (批量查询手艺人作品接口)

根据手艺人作品id列表和手艺人id查询手艺人作品信息。如果存在作品id列表,忽略其它参数,根据作品id列表查询; 如果没有作品id列表,则查询手艺人id下作品的详细信息。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
work_ids String [] 可选 64 手艺人作品id列表,全局唯一,是创建手艺人作品接口koubei.craftsman.data.work.create返回的work_id 2016100703485664
craftsman_id String 可选 64 口碑手艺人id。是创建手艺人接口koubei.craftsman.data.provider.create返回的craftsman_id,或通过查询手艺人信息接口koubei.craftsman.data.provider查询craftsman_id 210937
page_no String 必须 4 页码,大于0,最大为int的最大值 1
page_size String 必须 4 每页的条数,大于0,最大不超过100条 100
auth_code String 可选 64 服务商、服务商员工、商户、商户员工等口碑角色操作时必填,对应为《koubei.member.data.oauth.query》中的auth_code,默认有效期24小时;isv自身角色操作的时候,无需传该参数 6a8713a414da4a2dafdb7c24e597TX80

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
works CraftsmanWorkOpenModel [] 选填 - 作品信息列表
  • └ work_id
  • String
  • 必填
  • 64
  • 口碑手艺人作品id,是创建手艺人作品接口koubei.craftsman.data.work.create返回的work_id
  • 2016100703485660
  • └ title
  • String
  • 必填
  • 10
  • 作品标题,上限10个字。
  • 波波头
  • └ media_type
  • String
  • 必填
  • 16
  • 媒体类型。仅支持图片/视频格式,图片类型时为PICTURE;视频类型时为VIDEO
  • PICTURE/VIDEO
  • └ media_id
  • String
  • 必填
  • 128
  • 媒体资源id(通过 alipay.offline.material.image.upload 接口上传视频/图片获取的资源id)。图片上限最大5M,支持bmp,png,jpeg,jpg,gif格式的图片。视频上限最大50M,支持MP4格式。注意视频资源id的格式为视频id+竖线+视频头图id。举例:视频id为Qt5XB8R7SMizIC2CZ_qLXAAAACMAAQED,视频头图id为XXwcvckbS_WcT5-mYXtY1QAAACMAAQED; 则视频文件的字符串为Qt5XB8R7SMizIC2CZ_qLXAAAACMAAQED|XXwcvckbS_WcT5-mYXtY1QAAACMAAQED
  • Qt5XB8R7SMizIC2CZ_qLXAAAACMAAQED|XXwcvckbS_WcT5-mYXtY1QAAACMAAQED
  • └ craftsman_id
  • String
  • 必填
  • 64
  • 口碑手艺人id。是创建手艺人接口koubei.craftsman.data.provider.create返回的craftsman_id,或通过查询手艺人信息接口koubei.craftsman.data.provider查询craftsman_id
  • 123123
  • └ status
  • String
  • 必填
  • 16
  • 状态: EFFECTIVE 生效,INVALID 失效。失效状态主要用于平台对作品的处罚,例如作品涉黄赌毒、被用户投诉欺诈等。
  • EFFECTIVE/INVALID
  • └ duration
  • Number
  • 选填
  • 11
  • 视频资源必传 视频时长 单位(秒)
  • 150
page_size Number 必填 3 每页记录数 20
current_page_no Number 必填 9 当前页码 1
total_page_no Number 必填 9 总页码数目 3
total_works Number 必填 9 总共手艺人作品数目 50

请求示例

  • 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");
KoubeiCraftsmanDataWorkBatchqueryRequest request = new KoubeiCraftsmanDataWorkBatchqueryRequest();
request.setBizContent("{" +
"\"work_ids\":[" +
"\"2016100703485664\"" +
"]," +
"\"craftsman_id\":\"210937\"," +
"\"page_no\":\"1\"," +
"\"page_size\":\"100\"," +
"\"auth_code\":\"6a8713a414da4a2dafdb7c24e597TX80\"" +
"}");
KoubeiCraftsmanDataWorkBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"koubei_craftsman_data_work_batchquery_response":{
		"msg":"Success",
		"code":"10000",
		"works":[
			{
				"duration":150,
				"work_id":"2016100703485660",
				"craftsman_id":"123123",
				"media_type":"PICTURE/VIDEO",
				"media_id":"Qt5XB8R7SMizIC2CZ_qLXAAAACMAAQED|XXwcvckbS_WcT5-mYXtY1QAAACMAAQED",
				"title":"波波头",
				"status":"EFFECTIVE/INVALID"
			}
		],
		"total_page_no":3,
		"current_page_no":1,
		"total_works":50,
		"page_size":20
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 请按照错误码描述修改校验不通过的参数
OPUS_NOT_BELONGS_TO_PID 手艺人作品不属于该授权商户 权限不足,请使用作品发布时的商户授权信息进行查询
CRAFTSMAN_NOT_BELONGS_TO_PID 手艺人不属于该授权商户 请使用手艺人归属的商户授权信息访问该接口
SYSTEM_ERROR 系统繁忙 请给出手艺人id,外部作品id,联系技术支持,参考链接https://support.open.alipay.com/alipay/support/index.htm

公共错误码

返回
顶部