开发文档(V3版)
隐藏

上传门店照片和视频接口

努力加载中...
收藏
努力加载中...

接口说明

接口英文名称:alipay.offline.material.image.upload
请求url:https://openapi.alipay.com/v3/alipay/offline/material/image/upload
请求方式:POST
path 指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
系统商需要先将商户需要使用的图片和视频,上传支付宝服务器,生成对应的图片ID后才能够在口碑平台上配置相应图片

请求参数

公共请求参数

展开
参数 类型 是否必选 最大长度 描述 示例值
authorization String 必选 1024
请求身份信息,参考 验签规则 。在header参数中传递
content-type String 可选 32
报文内容格式,默认需要使用appliaction/json,加密请求使用text/plain,参考 请求规则 。在header参数中传递
appliaction/json
x-http-method-override String 可选 16
HTTP方法,对于部分不支持PUT、PATCH、DELETE等操作的情况,可以使用POST发送请求,并通过该参数传输实际需要使用的HTTP Method,参考 请求规则 。在header参数中传递
PUT
alipay-request-id String 可选 32
调用方的requestId,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考 请求规则 。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-type String 可选 16
加密算法,请求使用加密能力时,需要指定加密算法,参考 加解密规则 。在header参数中传递
AES
alipay-root-cert-sn String 可选 128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考 验签规则 。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-token String 可选 128
应用授权令牌,参考 代调用规则 。在header参数中传递
201509BBeff9351ad1874306903e96b91d248A36

业务请求参数

参数 类型 是否必选 最大长度 描述 示例值
image_type body String 必选 8
图片/视频格式
jpg或mp4
image_name body String 必选 128
图片/视频名称
海底捞
image_content body byte[] 必选 5242880
图片/视频二进制内容,图片/视频大小不能超过5M
-
image_pid body String 可选 16
用于显示指定图片/视频所属的partnerId(支付宝内部使用,外部商户无需填写此字段)
2088021822217233

请求示例

POST https://openapi.alipay.com/v3/alipay/offline/material/image/upload
Content-Type: multipart/form-data;boundary=--------boundary_value
--------boundary_value
Content-Disposition: form-data; name="data";
Content-Type: application/json
	"image_type":"jpg或mp4",
	"image_name":"海底捞",
	"image_pid":"2088021822217233"
--------boundary_value
Content-Disposition: form-data; name="image_content"; filename="file.jpg";
Content-Type: image/jpg
file.jpg文件内容
--------boundary_value

响应参数

公共响应参数

展开
参数 类型 是否必选 最大长度 描述 示例值
alipay-timestamp String 可选 32
unix时间戳,用于验签及问题排查,参考 验签规则 。在header参数中传递
1666004496123
alipay-signature String 可选 512
支付宝响应报文签名,参考 验签规则 。在header中返回
alipay-traceid String 可选 64
支付宝traceId ,用于排查问题使用,参考 请求规则 。在header中返回
0ba7cddb1665744697169391253118
alipay-nonce String 可选 64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考 请求规则 。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

参数 类型 是否必选 最大长度 描述 示例值
image_id String 必选 32
图片/视频在商家中心的唯一标识
hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED
image_url String 必选 512
图片/视频的访问地址(为了防止盗链,该地址不允许嵌在其他页面展示,只能在新页面展示)
http://dl.django.t.taobao.com/rest/1.0/image?fileIds=V9rfg69SSimLZg5wDA3yEgAAACMA...

响应示例

{
	"image_id":"hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED",
	"image_url":"http://dl.django.t.taobao.com/rest/1.0/image?fileIds=V9rfg69SSimLZg5wDA3yEgAAACMA..."
}

错误码

公共错误码

前往查看

业务错误码

状态码 错误码 错误描述 解决方案
400 isv.invalid-arguments 接口输入参数不合法
检查并更改输入参数
400 isv.exceed-max-size 超过单个图片允许的最大值 (5M)
请适当压缩图片大小以免超过上传限