淘宝开放平台

登录
文档中心 > API类目 > 用户API

用户API

taobao.video.add (淘宝短视频保存接口)

此api添加一个视频，视频发布后需要转码，审核等操作步骤，表示添加完成之后并不是立马能播放该视频，需要等后台转码成功，审核通过之后。线上视频转码审核过程比较快

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
upload_id String 必须 acsd-sdfsd-sfsdfs 上传的文件id
uploader_id Number 必须 123 上传者id（淘系账号）
video_base_info VideoBaseInfoDo 必须 视频基本信息
  • └ is2_upload_proxy
  • Boolean
  • 可选
  • false
  • 上传通道标识
  • └ cover_url
  • String
  • 必须
  • https://img.alicdn.com/a.jpg
  • 视频封面
  • └ description
  • String
  • 必须
  • 视频描述
  • 视频描述
  • └ options
  • Number
  • 必须
  • 0
  • 视频标识
  • └ tags
  • String []
  • 必须
  • 某某类
  • 视频标签
  • └ title
  • String
  • 必须
  • 某标题
  • 视频标题
video_extends_info Json 可选 {"a":"b"} 视频扩展信息
biz_app_key Number 必须 110 淘宝视频分配的appkey

响应参数

名称 类型 示例值 描述
result ResultDo result result
  • └ cause_detail
  • String
  • success
  • causeDetail
  • └ failure
  • Boolean
  • false
  • 是否失败
  • └ result
  • Number
  • 123
  • 返回结果
  • └ result_code
  • String
  • 456
  • 返回值结果码
  • └ is_success
  • Boolean
  • true
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
VideoAddRequest req = new VideoAddRequest();
req.setUploadId("acsd-sdfsd-sfsdfs");
req.setUploaderId(123L);
VideoAddRequest.VideoBaseInfoDo obj1 = new VideoAddRequest.VideoBaseInfoDo();
obj1.setIs2UploadProxy(false);
obj1.setPId(0L);
obj1.setCoverUrl("https://img.alicdn.com/a.jpg");
obj1.setDescription("视频描述");
obj1.setOptions(0L);
obj1.setTags("某某类");
obj1.setTitle("某标题");
obj1.setUserData("{\"a\":\"b\"}");
req.setVideoBaseInfo(obj1);
req.setVideoExtendsInfoString("{\"a\":\"b\"}");
req.setBizAppKey(110L);
VideoAddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
<video_add_response>
    <result>
        <cause_detail>success</cause_detail>
        <failure>false</failure>
        <result>123</result>
        <result_code>456</result_code>
        <is_success>true</is_success>
    </result>
</video_add_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isv.invalid-permission:userId userId无效 重新登录
isv.parameters-mismatch:userId and uploadId 传入的参数userId和uploadId不匹配，两者有一定的对应关系 视频上传者必须是当前登录者，只能往自己的账号传视频
isv.invalid-parameter:uploadId uploadId参数无效 uploadId必须通过上传服务获取
isv.invalid-parameter:videoBaseInfo 传入的视频信息为空 添加视频信息必须包含标题，标签，封面，描述等
isv.invalid-parameter:title 输入的标题无效 标题不为空且不能超过128汉字
isv.videoapi-service-error:add 调用视频add服务返回false，业务逻辑错误 根据返回的详细信息定位

API工具

API测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部