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

Go to download
{
	"mute": {
		"docs": "http://rongcloud.cn/docs/server.html#conversation_notification_set",
		"url": "conversation/notification/set",
		"params": {
			"conversation": {
				"type": "1",
				"targetId": "UAhIaLkR0",
				"userId": "b5NwvIrW8"
			}
		},
		"response":{
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型不正确，请检查参数类型,应该为 {{type}} 传入为 {{currentType}} "
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				}
			}
		}
	},
	"unmute": {
		"docs": "http://rongcloud.cn/docs/server.html#conversation_notification_set",
		"url": "conversation/notification/set",
		"params": {
			"conversation": {
				"type": "1",
				"targetId": "UAhIaLkR0",
				"userId": "b5NwvIrW8"
			}
		},
		"response":{
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20003": {
					"code": "1002",
					"errorMessage": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"20005": {
					"code": "1002",
					"errorMessage": "{{name}} 参数为必传项"
				},
				"20001": {
					"code": "1002",
					"errorMessage": "参数 类型不正确，请检查参数类型,应该为 {{type}} 传入为 {{currentType}} "
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				}
			}
		}
	},
	"get": {
		"docs": "http://rongcloud.cn/docs/server.html#conversation_notification_get",
		"url": "conversation/notification/get",
		"params": {
			"conversation": {
				"type": "1",
				"targetId": "UAhIaLkR0",
				"userId": "b5NwvIrW8"
			}
		},
		"response": {
			"success": {
				"code": "200",
				"isMuted": "0"
			},
			"fail": {
				"20003": {
					"code": "1002",
					"msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"1004": {
					"code": "1004",
					"msg": "签名错误, 请排查 Appkey、Secret 是否正确"
				}
			}
		}
	},
	"get": {
		"docs": "http://rongcloud.cn/docs/server.html#conversation_notification_get",
		"url": "conversation/notification/get",
		"params": {
			"conversation": {
				"type": "1",
				"targetId": "UAhIaLkR0",
				"userId": "b5NwvIrW8"
			}
		},
		"response": {
			"success": {
				"code": "200",
				"isMuted": "0"
			},
			"fail": {
				"20003": {
					"code": "20003",
					"msg": "{{name}} 长度超限, {{name}} >= {{min}} 且 {{name}} <= {{max}}"
				},
				"1004": {
					"code": "20000",
					"msg": "签名错误, 请排查 Appkey、Secret 是否正确"
				},
				"1008": {
					"code": "20001",
					"msg": "调用频率超限，每秒钟限制 100 次，调整频率上限请移步至专有云 http://www.rongcloud.cn/pricing#pay"
				}
			}
		}
	}
}