Notification.send
出自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 的版本号。 | ||
| uids | array | 指定接收通知用户的 ID,每个 ID 之间用逗号分割。指定的 ID 必须为已登录的用户好友的 ID 或已安装了您应用的用户 ID。如果您想将通知发送给当前登陆的用户并在通知里不显示接收人的名字,只需将本参数的值设置为空即可。 | ||
| msg | string | 指定在通知中包含的 MYML 代码,仅允许普通文本和链接。 | ||
| 可选 | format | string | 指定响应返回的格式。有 PHP (默认) 、 JSON 和 XML 这三种值可选。 |
请求范例
| 本例使用的是 PHP 客户端: // 实例化Manyou类库 $manyou = new Manyou($api_key, $api_secret); $manyou->api_client->notification_send('1000439', 'notification infomation'); |
JSON返回结果范例
| "true" |
错误代码
| 错误代码 | 描述 | |
| 1 | 发生了一个未知错误,请重新提交请求。 | |
|---|---|---|
| 2 | 目前服务不可用。 | |
| 4 | 应用请求已达到最大允许请求次数。 | |
| 5 | IP 地址被禁止。 | |
| 100 | 无效的参数。 | |
| 101 | 无效的 API Key。 | |
| 102 | 无效或已超时的 Session Key。请将用户引导至登陆页面以获得一个新的 Session Key。 | |
| 104 | 无效的签名值。 | |
| 801 | 数据长度超出限制。 |
说明
- 登陆用户的用户名将会被加到通知的开头。所以,在您设置 MYML 的时候,应该将 MYML 的第一词设为动词。但是,如果您将
uids设置为空值的话,那就不需要这么做了。
