媒体素材
上传文件
接口说明:文件上传,获取对应的 MEDIA ID(文件大小不能超过2M)请求方式:POST (HTTPS),Content-Type:multipart/form-data
请求地址: https://apigw-example.domain/v1/medias/create?type=TYPE&app_token=APP_TOKEN
注意:Content-Type 需要使用multipart/form-data 。文件标识名为”media”
query参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| user_token | 否 | 非必填字段,人员TOKEN |
| type | 是 | 文件类型。取值:VIDEO = 1;IMAGE = 2;AUDIO = 3; |
返回参数字段说明:|参数|类型|描述 | |------------|---------|-----------| | mediaId | string | 文件ID | | createdTime| string | 文件创建时间戳,单位微秒 |
返回数据示例:
业务正常返回:
{
"errCode": 0,
"errMsg": "ok",
"data":{
"mediaId": "524288-zK1dDdzmd0p7cNliYu9V5w7o8K0",
"createdTime": "1588226476000000"
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明:
下载文件
接口说明:根据media id 获取文件下载内容请求方式:GET (HTTPS)请求地址: https://apigw-example.domain/v1/medias/:mediaid/fetch?app_token=APP_TOKEN
注意:在正常响应报文里面的 Content-Type 不是通常的 application/json 。
query参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| user_token | 否 | 非必填字段,人员TOKEN |
param 参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| mediaid | 是 | 媒体文件ID |
返回数据示例:
业务正常返回:
{
HTTP/1.1 200 OK
Connection: close
Content-Type: image/jpeg
Content-disposition: attachment; filename="MEDIA_ID.jpg"
Date: Sun, 06 Jan 2013 10:20:18 GMT
Cache-Control: no-cache, must-revalidate
Content-Length: 339721
Xxxx
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明:
获取文件下载路径
接口说明:获取文件下载路径请求方式:GET (HTTPS)请求地址:https://apigw-example.domain/v1/medias/:mediaid/path/fetch?app_token=APP_TOKENquery参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| app_token | 是 | 应用访问TOKEN |
| user_token | 否 | 非必填字段,人员TOKEN |
param 参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| mediaid | 是 | 文件ID |
返回参数字段说明:|参数|类型|描述 | |-----------|--------|--------| | mediaPath | string |文件下载路径,非永久有效,有效期1小时 |
返回数据示例:
业务正常返回:
{
"errCode": 0,
"errMsg": "ok",
"data":{
"mediaPath": "http://www.test.cn/xxx",
"name": "",
"type": "",
"size": ""
}
}
业务异常返回:
{
"errCode": 错误码 ,
"errMsg": 对应的统一错误码描述
}
对应可能的错误码说明: