2/messages/invite
(以“=好友邀请接口= 功能: 好友邀请接口,支持登录用户向自己的微博互粉好友发送私信邀请 接口调用地址:https://m.api.weibo.com...”为内容创建页面) |
|||
(未显示1个用户的7个中间版本) | |||
第1行: | 第1行: | ||
=好友邀请接口= | =好友邀请接口= | ||
功能: | 功能: | ||
− | + | 好友邀请接口,支持登录用户向自己的微博互粉好友发送私信邀请、礼物 | |
第30行: | 第30行: | ||
|string | |string | ||
|true | |true | ||
− | | | + | |采用[[授权机制说明|OAuth2]]的[[Scope|Scope]]授权方式获得,详见[[授权机制说明|OAuth授权机制说明]] 。 |
|- | |- | ||
|uid | |uid | ||
第43行: | 第43行: | ||
|} | |} | ||
− | 注意事项 | + | |
− | * | + | ==注意事项== |
− | * | + | *1,应用引导用户使用微博登录,采用[[授权机制说明|OAuth2]]的[[scope|Scope]]授权方式获得用户“发送私信邀请给你的微博好友”权限,对应的scope权 |
− | * | + | **限参数为:invitation_write; |
+ | *2,每用户每小时通过每应用可邀请10个互粉好友; | ||
+ | *3,必须由授权用户主动发起,当检测到滥发或用户投诉将永久关停接口。 | ||
第53行: | 第55行: | ||
{|width="100%" border="0" cellspacing="0" cellpadding="0" class="wiki_table" | {|width="100%" border="0" cellspacing="0" cellpadding="0" class="wiki_table" | ||
<html><colgroup><col class="tbF1"/><col class="tbF2" /><col /></colgroup></html> | <html><colgroup><col class="tbF1"/><col class="tbF2" /><col /></colgroup></html> | ||
− | !colspan="4" scope="col" | | + | !colspan="4" scope="col" | |
|- | |- | ||
|style="text-align:center; width: 12%"|参数名称 | |style="text-align:center; width: 12%"|参数名称 | ||
第59行: | 第61行: | ||
|style="text-align:center;width: 11%"|是否必填 | |style="text-align:center;width: 11%"|是否必填 | ||
|style="text-align:center;"|说明描述 | |style="text-align:center;"|说明描述 | ||
− | |-|text|string|true| | + | |- |
− | |-|url|string|false|邀请点击后跳转链接。默认为当前应用地址。 | + | |text |
− | |-|invite_logo|string|false|邀请Card展示时的图标地址,大小必须为80px X 80px,仅支持PNG、JPG格式。默认为当前应用logo地址。 | + | |string |
+ | |true | ||
+ | |邀请内容。文本大小必须小于300个汉字。 | ||
+ | |- | ||
+ | |url | ||
+ | |string | ||
+ | |false | ||
+ | |邀请点击后跳转链接。默认为当前应用地址。 | ||
+ | |- | ||
+ | |invite_logo | ||
+ | |string | ||
+ | |false | ||
+ | |邀请Card展示时的图标地址,大小必须为80px X 80px,仅支持PNG、JPG格式。默认为当前应用logo地址。 | ||
|} | |} | ||
第72行: | 第86行: | ||
} | } | ||
</pre> | </pre> | ||
− | + | ||
+ | 将json采用UTF-8编码进行URLEncode后对应data参数值为: | ||
<pre class="brush:js"> | <pre class="brush:js"> | ||
"%7b%0a++++%22text%22%3a+%22%e8%bf%99%e4%b8%aa%e6%b8%b8%e6%88%8f%e5%a4%aa%e5%a5%bd%e7%8e%a9%e4%ba%86%ef%bc%8c%e5%8a%a0%e5%85%a5%e4%b8%80%e8%b5%b7%e7%8e%a9%e5%90%a7%22%2c%0a++++%22url%22%3a+%22http%3a%2f%2fapp.sina.com.cn%2fappdetail.php%3fappID%3d770915%22%2c%0a++++%22invite_logo%22%3a+%22http%3a%2f%2fhubimage.com2us.com%2fhubweb%2fcontents%2f123_499.jpg%22%0a%7d"。 | "%7b%0a++++%22text%22%3a+%22%e8%bf%99%e4%b8%aa%e6%b8%b8%e6%88%8f%e5%a4%aa%e5%a5%bd%e7%8e%a9%e4%ba%86%ef%bc%8c%e5%8a%a0%e5%85%a5%e4%b8%80%e8%b5%b7%e7%8e%a9%e5%90%a7%22%2c%0a++++%22url%22%3a+%22http%3a%2f%2fapp.sina.com.cn%2fappdetail.php%3fappID%3d770915%22%2c%0a++++%22invite_logo%22%3a+%22http%3a%2f%2fhubimage.com2us.com%2fhubweb%2fcontents%2f123_499.jpg%22%0a%7d"。 | ||
</pre> | </pre> | ||
+ | 调用示例: | ||
+ | <pre class="brush:js"> | ||
+ | curl -H "Authorization:OAuth2 USER_ACCESS_TOKEN" -d "uid=***&data=%7b%0a++++%22text%22%3a+%22%e8%bf%99%e4%b8%aa%e6%b8%b8%e6%88%8f%e5%a4%aa%e5%a5%bd%e7%8e%a9%e4%ba%86%ef%bc%8c%e5%8a%a0%e5%85%a5%e4%b8%80%e8%b5%b7%e7%8e%a9%e5%90%a7%22%2c%0a++++%22url%22%3a+%22http%3a%2f%2fapp.sina.com.cn%2fappdetail.php%3fappID%3d770915%22%2c%0a++++%22invite_logo%22%3a+%22http%3a%2f%2fhubimage.com2us.com%2fhubweb%2fcontents%2f123_499.jpg%22%0a%7d" "https://m.api.weibo.com/2/messages/invite.json" -k | ||
+ | 其中USER_ACCESS_TOKEN为普通用户授权给当前应用的token | ||
+ | </pre> | ||
==返回结果== | ==返回结果== | ||
第97行: | 第117行: | ||
{ | { | ||
"request": "/2/messages/invite.json", | "request": "/2/messages/invite.json", | ||
− | "error_code": | + | "error_code": 264XX, |
"error": "error message." | "error": "error message." | ||
} | } |
2014年1月15日 (三) 15:52的最后版本
好友邀请接口
功能: 好友邀请接口,支持登录用户向自己的微博互粉好友发送私信邀请、礼物
接口调用地址:https://m.api.weibo.com/2/messages/invite.json
HTTP请求方式:POST
是否需要登陆:是
频次限制:是
接口请求参数 | |||
---|---|---|---|
参数名称 | 值的类型 | 是否必填 | 说明描述 |
access_token | string | true | 采用OAuth2的Scope授权方式获得,详见OAuth授权机制说明 。 |
uid | int64 | true | 被邀请人,需为当前用户互粉好友。 |
data | string | true | 邀请数据。必须为json字串的形式,必须做URLEncode,采用UTF-8编码。 |
注意事项
- 1,应用引导用户使用微博登录,采用OAuth2的Scope授权方式获得用户“发送私信邀请给你的微博好友”权限,对应的scope权
- 限参数为:invitation_write;
- 2,每用户每小时通过每应用可邀请10个互粉好友;
- 3,必须由授权用户主动发起,当检测到滥发或用户投诉将永久关停接口。
data参数支持的参数:
参数名称 | 值的类型 | 是否必填 | 说明描述 |
text | string | true | 邀请内容。文本大小必须小于300个汉字。 |
url | string | false | 邀请点击后跳转链接。默认为当前应用地址。 |
invite_logo | string | false | 邀请Card展示时的图标地址,大小必须为80px X 80px,仅支持PNG、JPG格式。默认为当前应用logo地址。 |
举例,当data对应json为:
{ "text": "这个游戏太好玩了,加入一起玩吧", "url": "http://app.sina.com.cn/appdetail.php?appID=770915", "invite_logo": "http://hubimage.com2us.com/hubweb/contents/123_499.jpg" }
将json采用UTF-8编码进行URLEncode后对应data参数值为:
"%7b%0a++++%22text%22%3a+%22%e8%bf%99%e4%b8%aa%e6%b8%b8%e6%88%8f%e5%a4%aa%e5%a5%bd%e7%8e%a9%e4%ba%86%ef%bc%8c%e5%8a%a0%e5%85%a5%e4%b8%80%e8%b5%b7%e7%8e%a9%e5%90%a7%22%2c%0a++++%22url%22%3a+%22http%3a%2f%2fapp.sina.com.cn%2fappdetail.php%3fappID%3d770915%22%2c%0a++++%22invite_logo%22%3a+%22http%3a%2f%2fhubimage.com2us.com%2fhubweb%2fcontents%2f123_499.jpg%22%0a%7d"。
调用示例:
curl -H "Authorization:OAuth2 USER_ACCESS_TOKEN" -d "uid=***&data=%7b%0a++++%22text%22%3a+%22%e8%bf%99%e4%b8%aa%e6%b8%b8%e6%88%8f%e5%a4%aa%e5%a5%bd%e7%8e%a9%e4%ba%86%ef%bc%8c%e5%8a%a0%e5%85%a5%e4%b8%80%e8%b5%b7%e7%8e%a9%e5%90%a7%22%2c%0a++++%22url%22%3a+%22http%3a%2f%2fapp.sina.com.cn%2fappdetail.php%3fappID%3d770915%22%2c%0a++++%22invite_logo%22%3a+%22http%3a%2f%2fhubimage.com2us.com%2fhubweb%2fcontents%2f123_499.jpg%22%0a%7d" "https://m.api.weibo.com/2/messages/invite.json" -k 其中USER_ACCESS_TOKEN为普通用户授权给当前应用的token
返回结果
// 成功返回 { "id": 1211260020031347, "type": "invite", "recipient_id": 1902538057, "sender_id": 2489518277, "created_at": "Mon Jul 16 18:09:20 +0800 2012", "text": "这个游戏太好玩了,加入一起玩吧。http://t.cn/zHpnpxj", "data": { "url": "http://t.cn/zHpnpxj", "invite_logo": "http://hubimage.com2us.com/hubweb/contents/123_499.jpg" } } // 失败返回 { "request": "/2/messages/invite.json", "error_code": 264XX, "error": "error message." }
文档更新时间: 2014-01-15