jsonsource.message._private.api.json Maven / Gradle / Ivy

Go to download
{
	"send": {
		"url": "message/private/publish",
		"params": {
			"message": {
				"conversationType": 1,
				"senderId": "2191",
				"targetId": ["2192","2193"],
				"objectName": "RC:TxtMsg",
				"content": {
					"content":"hello"
				},
				"pushContent": "thisisapush",
				"pushData": {
					"pushData":"hello"
				},
				"isCounted": "1",
				"verifyBlacklist": 0,
				"isPersisted": 1,
				"isCounted": 1,
				"isIncludeSender": 0,
				"contentAvailable": 0
			}
		},
		"response": {
			"success": {
				"code": "200",
				"errorMessage": "成功返回"
			},
			"fail": {
				"20001": {
					"code": "1002",
					"errorMessage": "参数类型不正确，请检查参数类型,应该为 {{type}} 传入为 {{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 是否正确"
				}
			}
		}
	},
	"sendTemplate": {
		"url": "message/private/publish_template",
		"params": {
			"message": {
				"senderId": "fhdjfh00f",
				"objectName": "RC:TxtMsg",
				"template": {
					"content": "{name}, 语文成绩 {score} 分"
				},
				"content": {
					"sea9901": {
						"data": {
							"{name}": "小明",
							"{score}": "90"
						},
						"push": "{name} 考试成绩"
					},
					"sea9902": {
						"data": {
							"{name}": "小红",
							"{score}": "95"
						},
						"push": "{name} 考试成绩"
					}
				}
			}
		},
		"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 是否正确"
				}
			}
		}
	},
	"recall": {
		"docs": "http://rongcloud.cn/docs/server.html#message_recall",
		"url": "message/recall",
		"params": {
			"message": {
				"senderId": "fDR2cVpxxR5zSMUNh3yAwh",
				"targetId": "MersNRhaKwJkRV9mJR5JXY",
				"uId": "5FGT-7VA9-G4DD-4V5P",
				"sentTime": "20007778882124"
			}
		},
		"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": "参数类型不正确，请检查参数类型,应该为 {{type}} 传入为 {{currentType}} "
				},
				"1004": {
					"code": "1004",
					"errorMessage": "签名错误, 请排查 Appkey、Secret 是否正确"
				}
			}
		}
	}
}