Notification.get
出自Manyou开发者指南
目录 |
描述
获取当前登陆用户的通知信息。
参数
| 必选性 | 参数名 | 类型 | 描述 | |
| 必须 | 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 的版本号。 | ||
| 可选 | format | string | 指定响应返回的格式。有 PHP (默认) 、 JSON 和 XML 这三种值可选。 |
请求范例
本例使用的是 PHP 客户端:
// 实例化Manyou类库
$manyou = new Manyou($api_key, $api_secret);
$manyou->api_client->notification_get();
JSON返回结果范例
{"message":{"unread":"0","mostRecent":"0"},"notification"{"unread":"0","mostRecent":"0"},"friendRequest":{"uIds":[]}}
返回值
无论在哪个区域中,本方法都返回相同个格式的子元素。请注意,如果子元素 unread 的值是 0 的话,那么 most_recent 元素的值也为 0,否则,most_recent 元素的值将为最近通知的 ID。
如果您的应用中需要显示用户通知的话,我们建议您使用以下逻辑来判断是否需要显示这个通知:
if (unread > 0 && most_recent > old_most_recent) {
display_notification();
}
old_most_recent = most_recent;
错误代码
| 错误代码 | 描述 | |
| 1 | 发生了一个未知错误,请重新提交请求。 | |
|---|---|---|
| 2 | 目前服务不可用。 | |
| 4 | 应用请求已达到最大允许请求次数。 | |
| 5 | IP 地址被禁止。 | |
| 101 | 无效的 API Key。 | |
| 102 | 无效或已超时的 Session Key。请将用户引导至登陆页面以获得一个新的 Session Key。 | |
| 104 | 无效的签名值。 |
