jsonsource.sensitiveword.api.json Maven / Gradle / Ivy

Go to download
{
	"add": {
		"docs": "http://rongcloud.cn/docs/server.html#sensitiveword_add",
		"url": "sensitiveword/add",
		"params": {
			"sensitive": {
				"type": 1,
				"keyword": "法轮功",
				"replace": "***"
			}
		},
		"response": {
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20001": {
					"code": "1002",
					"errorMessage": "{{name}} 类型不正确，请检查参数类型,应该为 {{type}} 传入为 {{currentType}} "
				},
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}} 单位: 字节"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				}
			}
		}
	},
	"remove": {
		"docs": "http://rongcloud.cn/docs/server.html#sensitiveword_delete",
		"url": "sensitiveword/delete",
		"params": {
			"sensitive": {
				"keywords": "法轮功"
			}
		},
		"response": {
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型不正确，请检查参数类型,应该为 Object 传入为 {{currentType}} "
				},
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}} 单位: 字节"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "1008",
					"errorMessage": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	},
	"batchDelete": {
		"docs": "http://www.rongcloud.cn/docs/server.html#sensitiveword_batch_delete",
		"url": "/sensitiveword/batch/delete",
		"params": {
			"sensitive": {
				"keywords": ["法轮功", "国名党"]
			}
		},
		"response": {
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型类型不正确，请检查参数类型,应该为 Object 传入为 {{currentType}} "
				},
				"20002": {
					"code": "1002",
					"errorMessage": "{{name}} 数量超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}} 单位: 字节"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"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#sensitiveword_list",
		"url": "sensitiveword/list",
		"params": {},
		"response": {
			"success": {
				"code": 200,
				"words": [{
					"type": 0,
					"word": "黄赌毒",
					"replaceWord": "***"
				}, {
					"type": 0,
					"word": "法轮功",
					"replaceWord": "---"
				}]
			},
			"fail": {
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型不正确，请检查参数类型,应该为 Object 传入为 {{currentType}} "
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "1008",
					"errorMessage": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	}
}