用户自定义分组
(→修改自定义规则分组) |
(→获取自定义规则分组) |
||
| 第137行： | 第137行： | ||
=获取自定义规则分组= | =获取自定义规则分组= | ||
| + | |||
| + | '''接口调用请求说明：''' | ||
| + | |||
| + | <pre> | ||
| + | URL：/messages/custom_rule/get.json | ||
| + | |||
| + | HTTP 请求方式：POST | ||
| + | |||
| + | 是否需要登录：是 | ||
| + | |||
| + | 授权限制：频次限制是 | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;" | ||
| + | |- | ||
| + | !width="15%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数 | ||
| + | !width="25%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|必选 | ||
| + | !width="25%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|类型及范围 | ||
| + | !width="35%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|说明 | ||
| + | {{api_args|uid|true|long|用户ID}} | ||
| + | {{api_args|rule_type|false|int|获取规则 定义；默认不传返回所有自定义分组；1只返回自动分组；2返回全部分组信息}} | ||
| + | |} | ||
| + | |||
| + | |||
| + | '''返回结果：''' | ||
| + | <pre> | ||
| + | { | ||
| + | "groups": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "未分组", | ||
| + | "count": 72596, | ||
| + | "rule_type": 1 //0:私密自动规则；1:开放自动规则 | ||
| + | }, | ||
| + | { | ||
| + | "id": 1, | ||
| + | "name": "黑名单", | ||
| + | "count": 36, | ||
| + | "rule_type": 2 //2:自定义分组 | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | '''失败返回：''' | ||
| + | <pre> | ||
| + | { | ||
| + | "request": "XXXX/messages/custom_rule/get", | ||
| + | "errcode": "1000XX", | ||
| + | "errmsg": "error message." | ||
| + | } | ||
| + | </pre> | ||
| + | |||
=查询用户所在自定义分组= | =查询用户所在自定义分组= | ||
=更新用户所在自定义分组= | =更新用户所在自定义分组= | ||
2014年5月8日 (四) 16:33的版本
目录 |
设置自定义规则分组
接口调用请求说明：
URL：/messages/custom_rule/create.json HTTP 请求方式：POST 是否需要登录：是 授权限制：频次限制是
| 参数 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| uid | true | long | 用户ID |
| name | true | string | 分组名 |
返回结果：
{
"group": {
"id": 123123123123, //分组id
"name": "test" //分组名
}
}
失败返回：
{
"request": "XXXX/messages/custom_rule/create",
"errcode": "1000XX",
"errmsg": "error message."
}
删除自定义规则分组
接口调用请求说明：
URL：/messages/custom_rule/delete.json HTTP 请求方式：POST 是否需要登录：是 授权限制：频次限制是
| 参数 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| uid | true | long | 用户ID |
| id | true | long | 要删除的组ID |
返回结果：
{
"errcode": 0,
"errmsg": "ok"
}
失败返回：
{
"request": "XXXX/messages/custom_rule/delete",
"errcode": "1000XX",
"errmsg": "error message."
}
修改自定义规则分组
接口调用请求说明：
URL：/messages/custom_rule/update.json HTTP 请求方式：POST 是否需要登录：是 授权限制：频次限制是
| 参数 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| uid | true | long | 用户ID |
| id | true | long | 分组ID |
| name | true | string | 分组名 |
返回结果：
{
"errcode": 0,
"errmsg": "ok"
}
失败返回：
{
"request": "XXXX/messages/custom_rule/update",
"errcode": "1000XX",
"errmsg": "error message."
}
获取自定义规则分组
接口调用请求说明：
URL：/messages/custom_rule/get.json HTTP 请求方式：POST 是否需要登录：是 授权限制：频次限制是
| 参数 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| uid | true | long | 用户ID |
| rule_type | false | int | 获取规则 定义；默认不传返回所有自定义分组；1只返回自动分组；2返回全部分组信息 |
返回结果：
{
"groups": [
{
"id": 0,
"name": "未分组",
"count": 72596,
"rule_type": 1 //0:私密自动规则；1:开放自动规则
},
{
"id": 1,
"name": "黑名单",
"count": 36,
"rule_type": 2 //2:自定义分组
}
]
}
失败返回：
{
"request": "XXXX/messages/custom_rule/get",
"errcode": "1000XX",
"errmsg": "error message."
}
