通用场景
商家券
商家券历史版
营销通用上传图片接口
注意：
本接口为文件上传类接口，与普通openapi接口的入参构造格式不同，如果您没有使用官方sdk发起openapi调用，自行构造http请求时，需要使用multipart/form-data格式发起请求，注意以下事项：
1. 文件参数单独作为一个part，key为参数名，内容为文件，需要携带完整文件名（例如：content-disposition: form-data; name="file_content"; filename="example.png"），缺少文件名或后缀，会提示为类型错误。
2. 其余参数，对于v2版本的协议，公共参数需要使用query传入，业务参数使用query或body传入，使用body时每个字段作为一个单独part；v3协议需要按接口约定位置传入
1. 文件参数单独作为一个part，key为参数名，内容为文件，需要携带完整文件名（例如：content-disposition: form-data; name="file_content"; filename="example.png"），缺少文件名或后缀，会提示为类型错误。
2. 其余参数，对于v2版本的协议，公共参数需要使用query传入，业务参数使用query或body传入，使用body时每个字段作为一个单独part；v3协议需要按接口约定位置传入
公共请求参数
业务请求参数
file_content｜图片内容必选byte[](2097152)
【描述】图片的byte字节数组。图片大小限制为2m
【示例值】-
file_key｜文件业务标识特殊可选string(32)
【描述】文件业务标识。
枚举值
alipay.marketing.activity.delivery.create接口中
delivery_base_info.delivery_material.delivery_single_material.delivery_image
当delivery_booth_code=public_union，上传图片接口需指定file_key=public_union_channel_pic。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过200kb；
当delivery_booth_code=payment_result，上传图片接口需指定file_key=delivery_channel_pic。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过200kb。
上传图片更多要求参考文档： https://render.alipay.com/p/c/18tpirlg12e8?operatefrom=balipay
alipay.marketing.activity.ordervoucher.create接口中
voucher_display_info.brand_logo字段,file_key=promo_brand_logo，上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb
voucher_display_info.voucher_image字段,file_key=promo_voucher_image,上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb
【示例值】promo_voucher_image
merchant_access_mode｜商户接入模式特殊可选string(32)
【描述】商户接入模式
【枚举值】
商户自接入模式: self_mode
服务商代接入模式: agency_mode
【示例值】self_mode
belong_merchant_info｜归属商户信息可选belongmerchantinfo
【描述】服务商代商户创建投放必选
bussinesstype设置为isv_for_merchant。
merchant_id_type｜商户id类型特殊可选string(10)
【描述】商户id类型。特别说明：如果merchant_id_type选择smid。则表明当前商家券活动的归属者是该smid所绑定的支付宝pid。因此要求该smid必须绑定相应的支付宝pid。
【枚举值】
间连smid: smid
直连pid: pid
【注意事项】服务商代运营模式必传
【示例值】smid
merchant_id｜商户id特殊可选string(32)
【描述】商户pid,默认为当前接口调用商户。
【注意事项】1、服务商代运营模式必传
2、服务商代运营模式下服务商必须与商户建立代运营授权关系。
【必选条件】服务商代运营模式必传
【示例值】2088202967380463
business_type｜合作业务类型可选string(16)
【描述】合作业务类型,默认为isv_for_merchant
【枚举值】
服务商平台模式: isv
服务商代运营模式: isv_for_merchant
【注意事项】1、isv(平台模式)只有兑换券即voucher_type值为exchange_voucher时才能使用
【示例值】isv_for_merchant
常见请求示例
不带belong_merchant_info
带belong_merchant_info
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.material.image.upload&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'file_key=promo_voucher_image' \
-f 'file_content=@/home/admin/test.jpg' \
-f 'merchant_access_mode=self_mode' 说明：本示例仅供参考。
公共响应参数
业务响应参数
resource_id｜图片唯一资源id必选string(64)
【描述】图片唯一资源id
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
resource_enhance｜是否优化过可选boolean(16)
【描述】图片是否优化过。系统会根据要求，若上传的图片不符合要求的尺寸，会对上传的图片做尺寸的优化。
【示例值】false
resource_url｜图片的url地址可选string(128)
【描述】上传后图片的url地址
【示例值】https://mdn.alipayobjects.com/afts/img/a*o-bsqa2pnq4mifdcjunmqaaaarwnaq/original?bz=promo_merchant
响应示例
正常示例
异常示例
{
"alipay_marketing_material_image_upload_response": {
"code": "10000",
"msg": "success",
"resource_id": "adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"resource_enhance": false,
"resource_url": "https://mdn.alipayobjects.com/afts/img/a*o-bsqa2pnq4mifdcjunmqaaaarwnaq/original?bz=promo_merchant"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试 |
| file_size_out_of_range | 文件大小超过限制 | 请使用图片文件上传接口重新上传图片，大小不能超过2m |
| file_type_error | 文件格式不正确，不是图片文件格式 | 请使用图片上传接口上传图片类型的文件，不支持其他文件类型 |
| material_error | 文件格式不正确 | 请详细阅读相关接口字段描述，上传正确的文件。
请检查文件大小是否满足需求，图片宽度和高度是否满足需求，图片是否清晰，图片是否存在违规内容。 |
| pic_suffix_illegal | 文件后缀名称不合法 | 仅支持文件后缀名称为bmp, png, jpg, jpeg, gif的图片文件，请重新上传 |