jsonsource.chatroom.global-gag.api.json Maven / Gradle / Ivy

Go to download
{
	"add": {
		"docs": "http://rongcloud.cn/docs/server.html#chatroom_user_ban_add",
		"url": "chatroom/user/ban/add",
		"params": {
			"chatroom": {
				"members": [{
					"id": "memberId01"
				}],
				"minute": 100
			}
		},
		"response": {
			"success": {
				"code": 200,
				"errorMessage": "成功返回"
			},
			"fail": {
				"20002": {
					"code": "1002",
					"errorMessage": "{{name}} 数量超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}} 单位: 字节"
				},
				"20004": {
					"code": "1002",
					"errorMessage": "封禁时间 minute 不正确，minute >= 1 且 minute <= 43200 单位: 分钟"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型不正确，请检查参数类型,应该为 Object 传入为 {{currentType}} "
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "1008",
					"errorMessage": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	},
	"remove": {
		"docs": "http://rongcloud.cn/docs/server.html#chatroom_user_ban_remove",
		"url": "chatroom/user/ban/remove",
		"params": {
			"chatroom": {
				"members": [{
					"id": "memberId01"
				}]
			}
		},
		"response": {
			"success": {
				"code": 200,
				"errorMessage": "成功返回"
			},
			"fail": {
				"20002": {
					"code": "1002",
					"errorMessage": "{{name}} 个数超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}} 单位: 字节"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"20001": {
					"code": "1002",
					"errorMessage": "{{name}} 类型不正确，请检查参数类型,应该为 Object 传入为 {{currentType}} "
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "1008",
					"errorMessage": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	},
	"getList": {
		"docs": "http://rongcloud.cn/docs/server.html#chatroom_user_ban_query",
		"url": "chatroom/user/ban/query",
		"params": {},
		"response": {
			"success": {
				"code": "200",
				"members": [{
					"time": "2015-09-25 16:12:38",
					"id": "2582"
				}]
			},
			"fail": {
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "1008",
					"errorMessage": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	}
}