Eps/qrcode/create
(以“=创建二维码ticket= eps/qrcode/create接口用来创建二维码ticket ==URL== https://m.api.weibo.com/2/messages/reply.json ==HTTP请求方式== POST ==是...”为内容创建页面) |
|||
(未显示1个用户的4个中间版本) | |||
第1行: | 第1行: | ||
=创建二维码ticket= | =创建二维码ticket= | ||
− | + | 本接口用来创建二维码ticket | |
==URL== | ==URL== | ||
− | https:// | + | https://api.weibo.com/2/eps/qrcode/create.json |
==HTTP请求方式== | ==HTTP请求方式== | ||
第15行: | 第15行: | ||
==接口请求参数== | ==接口请求参数== | ||
+ | 临时二维码请求示例 | ||
+ | <pre class="brush:js"> | ||
+ | URL: https://api.weibo.com/2/eps/qrcode/create?access_token=TOKEN | ||
+ | POST数据例子:{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123123}}} | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | 永久二维码请求示例 | ||
+ | <pre class="brush:js"> | ||
+ | URL: https://api.weibo.com/2/eps/qrcode/create?access_token=TOKEN | ||
+ | POST数据例子:{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}} | ||
+ | </pre> | ||
+ | |||
+ | 参数详情: | ||
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;" | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;" | ||
|- | |- | ||
第23行: | 第37行: | ||
{{api_args|source|false|string|采用OAuth授权方式不需要此参数,其他授权方式为必填参数,数值为应用的AppKey。}} | {{api_args|source|false|string|采用OAuth授权方式不需要此参数,其他授权方式为必填参数,数值为应用的AppKey。}} | ||
{{api_args|access_token|false|string|采用OAuth授权方式为必填参数,其他授权方式不需要此参数,OAuth授权后获得。}} | {{api_args|access_token|false|string|采用OAuth授权方式为必填参数,其他授权方式不需要此参数,OAuth授权后获得。}} | ||
− | {{api_args| | + | {{api_args|expire_seconds|false|string|该二维码有效时间,以秒为单位。 最大不超过1800。}} |
− | {{api_args| | + | {{api_args|action_name|true|string|二维码类型,QR_SCENE为临时,QR_LIMIT_SCENE为永久。}} |
− | {{api_args| | + | {{api_args|scene_id|true|string|场景值ID,临时二维码时为32位非0整型,永久二维码时最大值为100000(目前参数只支持1--100000)。}} |
− | + | ||
|} | |} | ||
==注意事项== | ==注意事项== | ||
− | * | + | *1、如果action_name=QR_SCENE时,expire_seconds参数空缺,则默认为1800; |
− | * | + | *2、目前有2种类型的二维码,分别是临时二维码和永久二维码,前者有过期时间,最大为1800秒,但能够生成较多数量,后者无过期时间,数量较少(目前参数只支持1--100000); |
− | * | + | *3、获取带参数的二维码的过程包括两步,首先通过本接口创建二维码ticket,然后凭借ticket到调用qrcode/show接口换取二维码; |
− | * | + | *4、对于临时二维码,过期时间的计时起点是qrcode/create接口的调用时间; |
− | * | + | *5、用户一个未过期扫描带场景值二维码时,可能推送以下两种事件: |
− | * | + | **如果用户还未关注二维码生成方的官方账号,则扫描后进入关注列表;如果用户点击关注,则微博会给第三方推送如下格式的事件; |
− | * | + | <pre class="brush:js"> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | <pre> | + | |
{ | { | ||
− | "text": " | + | "id": 1211260020031346, |
+ | "type": "event", | ||
+ | "receiver_id": 1902538057, | ||
+ | "sender_id": 2489518277, | ||
+ | "created_at": "Mon Jul 16 18:09:20 +0800 2012", | ||
+ | "text": "扫描二维码", | ||
+ | "data": { | ||
+ | "subtype": "scan_follow", | ||
+ | "key": "action_name_scene_id", | ||
+ | "ticket": "ticket" | ||
+ | } | ||
} | } | ||
</pre> | </pre> | ||
− | + | **如果用户已经关注二维码生成方的官方账号,则扫描后进入和该官方账号的私信对话界面中,并且微博会给第三方推送如下格式的事件; | |
− | + | <pre class="brush:js"> | |
− | + | ||
− | + | ||
− | < | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{ | { | ||
− | " | + | "id": 1211260020031346, |
− | + | "type": "event", | |
− | + | "receiver_id": 1902538057, | |
− | + | "sender_id": 2489518277, | |
− | + | "created_at": "Mon Jul 16 18:09:20 +0800 2012", | |
− | + | "text": "扫描二维码", | |
− | + | "data": { | |
− | + | "subtype": "scan", | |
− | + | "key": "action_name_scene_id", | |
+ | "ticket": "ticket" | ||
+ | } | ||
} | } | ||
</pre> | </pre> | ||
− | + | 此接口不得用于推广或引导用户使用任何与新浪微博有直接竞争关系的公司的服务,否则将永久关停指定应用或V用户使用资格。 | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
==返回结果== | ==返回结果== | ||
第168行: | 第88行: | ||
// 成功返回 | // 成功返回 | ||
{ | { | ||
− | " | + | "ticket": "XXX", |
− | + | "expire_seconds": 1800 | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | " | + | |
} | } | ||
// 失败返回 | // 失败返回 | ||
{ | { | ||
− | "request": "/2/ | + | "request": "/2/eps/qrcode/create.json", |
− | "error_code": | + | "error_code": 284XX, |
"error": "error message." | "error": "error message." | ||
} | } |
2014年4月9日 (三) 22:23的最后版本
创建二维码ticket
本接口用来创建二维码ticket
URL
https://api.weibo.com/2/eps/qrcode/create.json
HTTP请求方式
POST
是否需要登录
是
关于登录授权,参见 如何登录授权
接口请求参数
临时二维码请求示例
URL: https://api.weibo.com/2/eps/qrcode/create?access_token=TOKEN POST数据例子:{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123123}}} }
永久二维码请求示例
URL: https://api.weibo.com/2/eps/qrcode/create?access_token=TOKEN POST数据例子:{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}}
参数详情:
必选 | 类型及范围 | 说明 | |
---|---|---|---|
source | false | string | 采用OAuth授权方式不需要此参数,其他授权方式为必填参数,数值为应用的AppKey。 |
access_token | false | string | 采用OAuth授权方式为必填参数,其他授权方式不需要此参数,OAuth授权后获得。 |
expire_seconds | false | string | 该二维码有效时间,以秒为单位。 最大不超过1800。 |
action_name | true | string | 二维码类型,QR_SCENE为临时,QR_LIMIT_SCENE为永久。 |
scene_id | true | string | 场景值ID,临时二维码时为32位非0整型,永久二维码时最大值为100000(目前参数只支持1--100000)。 |
注意事项
- 1、如果action_name=QR_SCENE时,expire_seconds参数空缺,则默认为1800;
- 2、目前有2种类型的二维码,分别是临时二维码和永久二维码,前者有过期时间,最大为1800秒,但能够生成较多数量,后者无过期时间,数量较少(目前参数只支持1--100000);
- 3、获取带参数的二维码的过程包括两步,首先通过本接口创建二维码ticket,然后凭借ticket到调用qrcode/show接口换取二维码;
- 4、对于临时二维码,过期时间的计时起点是qrcode/create接口的调用时间;
- 5、用户一个未过期扫描带场景值二维码时,可能推送以下两种事件:
- 如果用户还未关注二维码生成方的官方账号,则扫描后进入关注列表;如果用户点击关注,则微博会给第三方推送如下格式的事件;
{ "id": 1211260020031346, "type": "event", "receiver_id": 1902538057, "sender_id": 2489518277, "created_at": "Mon Jul 16 18:09:20 +0800 2012", "text": "扫描二维码", "data": { "subtype": "scan_follow", "key": "action_name_scene_id", "ticket": "ticket" } }
- 如果用户已经关注二维码生成方的官方账号,则扫描后进入和该官方账号的私信对话界面中,并且微博会给第三方推送如下格式的事件;
{ "id": 1211260020031346, "type": "event", "receiver_id": 1902538057, "sender_id": 2489518277, "created_at": "Mon Jul 16 18:09:20 +0800 2012", "text": "扫描二维码", "data": { "subtype": "scan", "key": "action_name_scene_id", "ticket": "ticket" } }
此接口不得用于推广或引导用户使用任何与新浪微博有直接竞争关系的公司的服务,否则将永久关停指定应用或V用户使用资格。
返回结果
// 成功返回 { "ticket": "XXX", "expire_seconds": 1800 } // 失败返回 { "request": "/2/eps/qrcode/create.json", "error_code": 284XX, "error": "error message." }
文档更新时间: 2014-04-09