Feed.publishTemplatizedAction
出自Manyou开发者指南
目录 |
描述
向当前用户发送 Feed,当前用户由 session_key 参数指定。本方法会将 Feed 发送到当前登陆用户的页面。
参数
| 必选性 | 参数名 | 类型 | 描述 | |
| 必选 | api_key | string | 申请应用时生成的 API Key。 | |
|---|---|---|---|---|
| session_key | string | 当前登录用户的 Session Key。 | ||
| call_id | float | 请求序列值。每个请求都有一个序列值,并且后一个比前一个大,序列值和 session 无关。我们建议您使用以毫秒为单位的当前时间的值,类似 PHP 中的 microtime(true) 函数。 | ||
| sig | string | MD5 串。根据当前请求和 Secret 值加密获得。 | ||
| v | string | 本参数的值必须设置为 1.0,表示 API 的版本号。 | ||
| title_template | markup | 指定 Feed 标题区域的模板标记,可以包含 {actor} 标记,表示 Feed 发起人的名字。 | ||
| 可选 | format | string | 指定响应返回的格式。有 PHP (默认) 、 JSON 和 XML 这三种值可选。 | |
| title_data | string | JSON 格式的数组,此数组将代入到 title_template 设定的模板标记中。数组的下标为标记名,而对应的值为想要代入模板的值。'actor' 为特殊标记,所以不应包含被在数组中。如果 title_template 没有包括 'actor',则这个参数为必须给定。 | ||
| 可选 | body_template | markup | 指定在 Feed 主体区域内的模板标记。 | |
| body_data | string | JSON 格式的数组,此数组将代入到 body_template 设定的模板标记中。数组的下标为标记名,而对应的值为想要代入模板的值。如果 body_template 没有包括 'actor',则这个参数为必须给定。 | ||
| body_general | markup | 指定 Feed 中的引言部分。如果两个或更多 Feed 合并为一个,那么所有 Feed 中的 body_general 的内容都将会直接显示出来,而不是合并掉。 | ||
| image_1 | string | 指定在 Feed 上显示图片的路径。类似 body_general,显示图片将不进行聚合,但任意一个聚合 Feed 中的图像可能会被显示。 | ||
| image_1_link | string | 指定 image_1 标签图像的超链接。 | ||
| image_2 | string | 指定在 Feed 上显示图片的路径。类似 body_general,显示图片将不进行聚合,但任意一个聚合 Feed 中的图像可能会被显示。 | ||
| image_2_link | string | 指定 image_2 标签图像的超链接。 | ||
| image_3 | string | 指定在 Feed 上显示图片的路径。类似 body_general,显示图片将不进行聚合,但任意一个聚合 Feed 中的图像可能会被显示。 | ||
| image_3_link | string | 指定 image_3 标签图像的超链接。 | ||
| image_4 | string | 指定在 Feed 上显示图片的路径。类似 body_general,显示图片将不进行聚合,但任意一个聚合 Feed 中的图像可能会被显示。 | ||
| image_4_link | string | 指定 image_4 标签图像的超链接。 |
请求范例
| 本例使用的是 PHP 客户端: // 实例化Manyou类库 $manyou = new Manyou($api_key, $api_secret); $manyou->api_client->feed_publishTemplatizedAction($title_template,$title_data,$body_template,$body_data,$body_general,$image_1,$image_1_link,$image_2,$image_2_link,$image_3,$image_3_link,$image_4,$image_4_link); |
返回结果范例
参数示例
|
JSON返回结果范例
| "true" |
返回值
本方法成功时返回 true,失败或没有权限时返回 false。
错误代码
| 错误代码 | 描述 | |
| 1 | 发生了一个未知错误,请重新提交请求。 | |
|---|---|---|
| 2 | 目前服务不可用。 | |
| 4 | 应用请求已达到最大允许请求次数。 | |
| 5 | IP 地址被禁止。 | |
| 100 | 无效的参数。 | |
| 101 | 无效的 API Key。 | |
| 102 | 无效或已超时的 Session Key。请将用户引导至登陆页面以获得一个新的 Session Key。 | |
| 104 | 无效的签名值。 | |
| 330 | 标记无效或长度超出限制。 | |
| 341 | Feed 操作次数超出限制。 | |
| 360 | title_data 的值不是有效的 JSON 数组 | |
| 361 | 没有找到 title template 参数,或 title_data 数组参数不全 | |
| 362 | body_data 参数的值不是一个有效的 JSON 数组。 | |
| 363 | 没有找到 body template 或 body_data 数组参数不全。 | |
| 364 | 无效的图片地址。 |
说明
发送 Feed 时,您需要首先了解发布 Feed 的相关条款。
- title_template 参数必须给定,并且必须小于 60 个字符长度(标签不计算在内)。
- 必须包含 '{actor}' 标签,此标签将会在编译模板时用发起人的名字替换。
- 参数中允许包含一些其它的模板标记,每个标记必须用大括号 {} 括起来,这些模板标记将使用 title_data 中的对应数据替代。
- 本参数中仅允许使用 <my:name> 和
<a>标签,其他标签不允许使用。
- body_template 参数是可选的,如果给定,它的值必须小于 200 个字符长度(标签不计算在内)。
- 本参数可以包含 '{actor}' 标签,但不是必须的。
- 本参数中仅允许使用 <my:name>、
<a>、<b>和<i>标签,其他标签不允许使用。
- title_data 和 body_data 必须为 JSON 格式的数组,它们的值会分别代入到 title_template 和 body_template 中。
- 两条或更多的 Feed 可能会被合并为一条。
- 要使两条 Feed 合并为一条,title_template 和 body_template 必须是完全相同的,并且 title_data 和 body_data 中的数组必须包含同样的下标(key)和值(value)。
- 如果两条或更多条的 Feed 被合并为了一条,那么 {actor} 这个标记将会被替换成所有人的名字。
- Feed 中最多可以显示 4 图片,并且每个图片都会被按比例缩放到 100x100 像素,并被缓存起来。您使用的图片应该是没有版权问题的,并且您必须允许 Manyou 缓存它。您可以为每个图片加上链接,链接地址必须以 http:// 开头。
- 如果两条或更多条的 Feed 被合并为了一条,那么只有每个 Feed 中有的 body_general 内容和图片才会被显示出来。
- 除非完全相同,否则来自同一个人的 Feed 不会被合并。
- 在 48 小时之内,您给同一个用户最多只能发送 10 条 Feed。
- Feed 不一定会显示在用户好友的 Feed 列表中,显示还是不显示取决于 Feed 的质量。
