上传下载多媒体文件

跳转到: 导航, 搜索
(接口请求参数)
(返回结果)
 
(未显示1个用户的43个中间版本)
第1行: 第1行:
=上传下载多媒体文件=
 
  
公众号在使用接口时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。通过本接口,公众号可以上传或下载多媒体文件。
+
=上传多媒体文件=
 +
在使用接口时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。通过本接口,可以上传多媒体文件。
  
 
==文件上传接口==
 
==文件上传接口==
第32行: 第32行:
 
|}
 
|}
  
==注意事项==
+
==相关约束==
*1、发送方的uid信息是由access_token参数决定的;
+
 
*2、调用接口时,需要消息发送方有针对于消息接收方的消息配额;一般来说,如果消息接收方给消息发送方主动发送过消息,则在7天内,消息发送方具备针对于消息接收方的主动配额一条;
+
 
*3、对于使用长连接接入模式的开发者,message/reply接口的调用方式略有不同,详情请参考http://open.weibo.com/wiki/2/messages/reply 文档;
+
*1、必须用Multipart/form-data方式
 +
 
 +
*使用curl命令,用FORM表单方式上传一个多媒体文件:
 +
 
 +
*curl  -H "Authorization:OAuth2 USER_ACCESS_TOKEN" -F "media=@test.jpg"
 +
 
 +
*“http://upload.api.weibo.com/2/mss/media_upload.json?type=TYPE”
 +
 
 +
 
 +
*2、上传的多媒体文件有格式和大小限制,如下:
 +
 
 +
*图片(image):1MB,支持bmp,jpg,tiff,gif,pcx,tga,exif,fpx,svg,psd,cdr,pcd,dxf,ufo,eps,ai,png,raw格式
 +
 
 +
*语音(voice):1MB,支持AMR\MP3格式
 +
 
 +
*视频(video):2MB,支持MP4格式
 +
 
 +
*缩略图(thumb):128K,支持bmp,jpg,tiff,gif,pcx,tga,exif,fpx,svg,psd,cdr,pcd,dxf,ufo,eps,ai,png,raw格式
 +
 
 +
==返回结果==
 +
正确情况下的返回JSON数据包结果如下:
 +
<pre>
 +
{
 +
    "type":"TYPE",
 +
    "media_id":"MEDIA_ID",
 +
    "created_at":123456789
 +
}
 +
</pre>
 +
 
 +
 
 +
 
 +
参数说明:
 +
 
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;"
 +
|-
 +
!width="20%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数
 +
!width="80%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|描述
 +
|-
 +
|style="border:1px solid #cccccc;text-align:center"| type
 +
|style="border:1px solid #cccccc;text-align:left"| &nbsp;媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb,主要用于视频与音乐格式的缩略图)
 +
|-
 +
|style="border:1px solid #cccccc;text-align:center"| media_id
 +
|style="border:1px solid #cccccc;text-align:left"|  &nbsp;媒体文件上传后,获取时的唯一标识
 +
|-
 +
| style="border:1px solid #cccccc;text-align:center"|created_at
 +
|style="border:1px solid #cccccc;text-align:left"|  &nbsp;媒体文件上传时间戳
 +
|}
 +
 
 +
 
 +
 
 +
错误情况下的返回JSON数据包示例如下:
 +
<pre>
 +
{
 +
    "error":"invalid media type",
 +
    "error_code":20354,
 +
    "request":"/2/mss/media_upload.json",
 +
    "http_code":400
 +
}
 +
</pre>
 +
 
 +
=下载多媒体文件=
 +
 
 +
在使用接口时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。通过本接口,可以下载多媒体文件。
 +
 
 +
==文件下载接口==
 +
mss/msget
 +
 
 +
==URL==
 +
http://upload.api.weibo.com/2/mss/media_msget.json
 +
 
 +
==支持格式==
 +
JSON
 +
 
 +
==HTTP请求方式==
 +
GET
 +
 
 +
==是否需要登录==
 +
是<br/>
 +
关于登录授权,参见 [[授权机制说明|如何登录授权]]
 +
 
 +
 
 +
==接口请求参数==
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;"
 +
|-
 +
!width="10%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数
 +
!width="10%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|必选
 +
!width="10%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|类型
 +
!width="70%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|说明
 +
{{api_args|source|true|string|申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)}}
 +
{{api_args|media|true| |媒体文件ID}}
 +
|}
 +
 
 +
==调用示例==
 +
<pre>
 +
http请求方式: GET
 +
http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID
 +
请求示例(示例为通过curl命令获取多媒体文件)
 +
curl -I -G "http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID"
 +
</pre>
 +
 
 +
 
 +
==返回结果==
 +
正确情况下返回的HTTP头如下:
 +
<pre>
 +
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
 +
curl -G "http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID"
 +
</pre>
 +
 
 +
 
 +
错误情况下的返回JSON数据包示例如下:
 +
<pre>
 +
{
 +
    "request":"\/file\/attachment\/real_url.json",
 +
    "err_code":3,"err_msg":"file is non-existent"
 +
}
 +
</pre>

2014年6月13日 (五) 14:18的最后版本

目录

上传多媒体文件

在使用接口时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。通过本接口,可以上传多媒体文件。

文件上传接口

mss/media_upload

URL

http://upload.api.weibo.com/2/mss/media_upload.json

支持格式

JSON

HTTP请求方式

POST

是否需要登录


关于登录授权,参见 如何登录授权


接口请求参数

参数 必选 类型 说明
source true string 申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)
type true string 媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)
media true form-data中媒体文件标识,有filename、filelength、content-type等信息

相关约束

  • 1、必须用Multipart/form-data方式
  • 使用curl命令,用FORM表单方式上传一个多媒体文件:
  • curl -H "Authorization:OAuth2 USER_ACCESS_TOKEN" -F "media=@test.jpg"


  • 2、上传的多媒体文件有格式和大小限制,如下:
  • 图片(image):1MB,支持bmp,jpg,tiff,gif,pcx,tga,exif,fpx,svg,psd,cdr,pcd,dxf,ufo,eps,ai,png,raw格式
  • 语音(voice):1MB,支持AMR\MP3格式
  • 视频(video):2MB,支持MP4格式
  • 缩略图(thumb):128K,支持bmp,jpg,tiff,gif,pcx,tga,exif,fpx,svg,psd,cdr,pcd,dxf,ufo,eps,ai,png,raw格式

返回结果

正确情况下的返回JSON数据包结果如下:

{
    "type":"TYPE",
    "media_id":"MEDIA_ID",
    "created_at":123456789
}


参数说明:

参数 描述
type  媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb,主要用于视频与音乐格式的缩略图)
media_id  媒体文件上传后,获取时的唯一标识
created_at  媒体文件上传时间戳


错误情况下的返回JSON数据包示例如下:

{
    "error":"invalid media type",
    "error_code":20354,
    "request":"/2/mss/media_upload.json",
    "http_code":400
}

下载多媒体文件

在使用接口时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。通过本接口,可以下载多媒体文件。

文件下载接口

mss/msget

URL

http://upload.api.weibo.com/2/mss/media_msget.json

支持格式

JSON

HTTP请求方式

GET

是否需要登录


关于登录授权,参见 如何登录授权


接口请求参数

参数 必选 类型 说明
source true string 申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)
media true 媒体文件ID

调用示例

http请求方式: GET
http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID
请求示例(示例为通过curl命令获取多媒体文件)
curl -I -G "http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID"


返回结果

正确情况下返回的HTTP头如下:

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
curl -G "http://upload.api.weibo.com/2/mss/media_msget.json?source=xxx&media_id=MEDIA_ID"


错误情况下的返回JSON数据包示例如下:

{
    "request":"\/file\/attachment\/real_url.json",
    "err_code":3,"err_msg":"file is non-existent"
}
文档更新时间: 2014-06-13