AppChatHttpInput.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Plugin.WorkWeixin.Proxy;
  7. /// <summary>
  8. /// 创建群聊会话输入参数
  9. /// </summary>
  10. public class CreatAppChatInput
  11. {
  12. /// <summary>
  13. /// 群名称
  14. /// </summary>
  15. [JsonProperty("name")]
  16. [JsonPropertyName("name")]
  17. [Required(ErrorMessage = "群名称不能为空"), MaxLength(50, ErrorMessage = "群名称最多不能超过50个字符")]
  18. public string Name { get; set; }
  19. /// <summary>
  20. /// 群主Id
  21. /// </summary>
  22. [JsonProperty("owner")]
  23. [JsonPropertyName("owner")]
  24. [Required(ErrorMessage = "群主Id不能为空")]
  25. public string Owner { get; set; }
  26. /// <summary>
  27. /// 群成员Id列表
  28. /// </summary>
  29. [JsonProperty("userlist")]
  30. [JsonPropertyName("userlist")]
  31. [Core.NotEmpty(ErrorMessage = "群成员列表不能为空")]
  32. public List<string> UserList { get; set; }
  33. /// <summary>
  34. /// 群Id
  35. /// </summary>
  36. [JsonProperty("chatid")]
  37. [JsonPropertyName("chatid")]
  38. [Required(ErrorMessage = "群Id不能为空"), MaxLength(32, ErrorMessage = "群Id最多不能超过32个字符")]
  39. public string ChatId { get; set; }
  40. }
  41. /// <summary>
  42. /// 修改群聊会话输入参数
  43. /// </summary>
  44. public class UpdateAppChatInput
  45. {
  46. /// <summary>
  47. /// 群Id
  48. /// </summary>
  49. [JsonProperty("chatid")]
  50. [JsonPropertyName("chatid")]
  51. [Required(ErrorMessage = "群Id不能为空"), MaxLength(32, ErrorMessage = "群Id最多不能超过32个字符")]
  52. public string ChatId { get; set; }
  53. /// <summary>
  54. /// 群名称
  55. /// </summary>
  56. [JsonProperty("name")]
  57. [JsonPropertyName("name")]
  58. [Required(ErrorMessage = "群名称不能为空"), MaxLength(50, ErrorMessage = "群名称最多不能超过50个字符")]
  59. public string Name { get; set; }
  60. /// <summary>
  61. /// 群主Id
  62. /// </summary>
  63. [JsonProperty("owner")]
  64. [JsonPropertyName("owner")]
  65. [Required(ErrorMessage = "群主Id不能为空")]
  66. public string Owner { get; set; }
  67. /// <summary>
  68. /// 添加成员的id列表
  69. /// </summary>
  70. [JsonProperty("add_user_list")]
  71. [JsonPropertyName("add_user_list")]
  72. public List<string> AddUserList { get; set; }
  73. /// <summary>
  74. /// 踢出成员的id列表
  75. /// </summary>
  76. [JsonProperty("del_user_list")]
  77. [JsonPropertyName("del_user_list")]
  78. public List<string> DelUserList { get; set; }
  79. }
  80. /// <summary>
  81. /// 应用消息推送输入基类参数
  82. /// </summary>
  83. public class SendBaseAppChatInput
  84. {
  85. /// <summary>
  86. /// 群Id
  87. /// </summary>
  88. [JsonProperty("chatid")]
  89. [JsonPropertyName("chatid")]
  90. [Required(ErrorMessage = "群Id不能为空"), MaxLength(32, ErrorMessage = "群Id最多不能超过32个字符")]
  91. public string ChatId { get; set; }
  92. /// <summary>
  93. /// 消息类型
  94. /// </summary>
  95. /// <example>text:文本消息</example>
  96. /// <example>image:图片消息</example>
  97. /// <example>voice:图片消息</example>
  98. /// <example>video:视频消息</example>
  99. /// <example>file:文件消息</example>
  100. /// <example>textcard:文本卡片</example>
  101. /// <example>news:图文消息</example>
  102. /// <example>mpnews:图文消息(存储在企业微信)</example>
  103. /// <example>markdown:markdown消息</example>
  104. [JsonProperty("msgtype")]
  105. [JsonPropertyName("msgtype")]
  106. [Required(ErrorMessage = "消息类型不能为空")]
  107. protected string MsgType { get; set; }
  108. /// <summary>
  109. /// 是否是保密消息
  110. /// </summary>
  111. [JsonProperty("safe")]
  112. [JsonPropertyName("safe")]
  113. [Required(ErrorMessage = "消息类型不能为空")]
  114. public int Safe { get; set; }
  115. public SendBaseAppChatInput(string chatId, string msgType, bool safe = false)
  116. {
  117. ChatId = chatId;
  118. MsgType = msgType;
  119. Safe = safe ? 1 : 0;
  120. }
  121. }
  122. /// <summary>
  123. /// 推送文本消息输入参数
  124. /// </summary>
  125. public class SendTextAppChatInput : SendBaseAppChatInput
  126. {
  127. /// <summary>
  128. /// 消息内容
  129. /// </summary>
  130. [JsonProperty("text")]
  131. [JsonPropertyName("text")]
  132. public object Text { get; set; }
  133. /// <summary>
  134. /// 文本消息
  135. /// </summary>
  136. /// <param name="chatId"></param>
  137. /// <param name="content"></param>
  138. /// <param name="safe"></param>
  139. public SendTextAppChatInput(string chatId, string content, bool safe = false) : base(chatId, "text", safe)
  140. {
  141. Text = new { content };
  142. }
  143. }
  144. /// <summary>
  145. /// 推送图片消息输入参数
  146. /// </summary>
  147. public class SendImageAppChatInput : SendBaseAppChatInput
  148. {
  149. /// <summary>
  150. /// 消息内容
  151. /// </summary>
  152. [JsonProperty("image")]
  153. [JsonPropertyName("image")]
  154. public object Image { get; set; }
  155. /// <summary>
  156. /// 图片消息
  157. /// </summary>
  158. /// <param name="chatId"></param>
  159. /// <param name="mediaId"></param>
  160. /// <param name="safe"></param>
  161. public SendImageAppChatInput(string chatId, string mediaId, bool safe = false) : base(chatId, "image", safe)
  162. {
  163. Image = new { media_id = mediaId };
  164. }
  165. }
  166. /// <summary>
  167. /// 推送语音消息输入参数
  168. /// </summary>
  169. public class SendVoiceAppChatInput : SendBaseAppChatInput
  170. {
  171. /// <summary>
  172. /// 消息内容
  173. /// </summary>
  174. [JsonProperty("voice")]
  175. [JsonPropertyName("voice")]
  176. public object Voice { get; set; }
  177. /// <summary>
  178. /// 语音消息
  179. /// </summary>
  180. /// <param name="chatId"></param>
  181. /// <param name="mediaId"></param>
  182. /// <param name="safe"></param>
  183. public SendVoiceAppChatInput(string chatId, string mediaId, bool safe = false) : base(chatId, "voice", safe)
  184. {
  185. Voice = new { media_id = mediaId };
  186. }
  187. }
  188. /// <summary>
  189. /// 推送视频消息输入参数
  190. /// </summary>
  191. public class SendVideoAppChatInput : SendBaseAppChatInput
  192. {
  193. /// <summary>
  194. /// 消息内容
  195. /// </summary>
  196. [JsonProperty("video")]
  197. [JsonPropertyName("video")]
  198. public object Video { get; set; }
  199. /// <summary>
  200. /// 视频消息
  201. /// </summary>
  202. /// <param name="chatId"></param>
  203. /// <param name="title"></param>
  204. /// <param name="description"></param>
  205. /// <param name="mediaId"></param>
  206. /// <param name="safe"></param>
  207. public SendVideoAppChatInput(string chatId, string title, string description, string mediaId, bool safe = false) : base(chatId, "video", safe)
  208. {
  209. Video = new
  210. {
  211. media_id = mediaId,
  212. description,
  213. title
  214. };
  215. }
  216. }
  217. /// <summary>
  218. /// 推送视频消息输入参数
  219. /// </summary>
  220. public class SendFileAppChatInput : SendBaseAppChatInput
  221. {
  222. /// <summary>
  223. /// 消息内容
  224. /// </summary>
  225. [JsonProperty("file")]
  226. [JsonPropertyName("file")]
  227. public object File { get; set; }
  228. /// <summary>
  229. /// 文件消息
  230. /// </summary>
  231. /// <param name="chatId"></param>
  232. /// <param name="mediaId"></param>
  233. /// <param name="safe"></param>
  234. public SendFileAppChatInput(string chatId, string mediaId, bool safe = false) : base(chatId, "video", safe)
  235. {
  236. File = new { media_id = mediaId };
  237. }
  238. }
  239. /// <summary>
  240. /// 推送文本卡片消息输入参数
  241. /// </summary>
  242. public class SendTextCardAppChatInput : SendBaseAppChatInput
  243. {
  244. /// <summary>
  245. /// 消息内容
  246. /// </summary>
  247. [JsonProperty("textcard")]
  248. [JsonPropertyName("textcard")]
  249. public object TextCard { get; set; }
  250. /// <summary>
  251. /// 文本卡片消息
  252. /// </summary>
  253. /// <param name="chatId"></param>
  254. /// <param name="title">标题</param>
  255. /// <param name="description">描述</param>
  256. /// <param name="url">点击后跳转的链接</param>
  257. /// <param name="btnTxt">按钮文字</param>
  258. /// <param name="safe"></param>
  259. public SendTextCardAppChatInput(string chatId, string title, string description, string url, string btnTxt, bool safe = false) : base(chatId, "textcard", safe)
  260. {
  261. TextCard = new
  262. {
  263. title,
  264. description,
  265. url,
  266. btntxt = btnTxt
  267. };
  268. }
  269. }
  270. /// <summary>
  271. /// 图文消息项
  272. /// </summary>
  273. public class SendNewsItem
  274. {
  275. /// <summary>
  276. /// 标题
  277. /// </summary>
  278. [JsonProperty("title")]
  279. [JsonPropertyName("title")]
  280. public string Title { get; set; }
  281. /// <summary>
  282. /// 描述
  283. /// </summary>
  284. [JsonProperty("description")]
  285. [JsonPropertyName("description")]
  286. public string Description { get; set; }
  287. /// <summary>
  288. /// 描述
  289. /// </summary>
  290. [JsonProperty("url")]
  291. [JsonPropertyName("url")]
  292. public string Url { get; set; }
  293. /// <summary>
  294. /// 图文消息的图片链接(推荐大图1068 * 455,小图150 * 150)
  295. /// </summary>
  296. [JsonProperty("picurl")]
  297. [JsonPropertyName("picurl")]
  298. public string PicUrl { get; set; }
  299. }
  300. /// <summary>
  301. /// 推送图文消息输入参数
  302. /// </summary>
  303. public class SendNewsAppChatInput : SendBaseAppChatInput
  304. {
  305. /// <summary>
  306. /// 消息内容
  307. /// </summary>
  308. [JsonProperty("news")]
  309. [JsonPropertyName("news")]
  310. public object News { get; set; }
  311. /// <summary>
  312. /// 图文消息
  313. /// </summary>
  314. /// <param name="chatId"></param>
  315. /// <param name="newsList">图文消息列表</param>
  316. /// <param name="safe"></param>
  317. public SendNewsAppChatInput(string chatId, List<SendNewsItem> newsList, bool safe = false) : base(chatId, "news", safe)
  318. {
  319. News = new { articles = newsList };
  320. }
  321. }
  322. /// <summary>
  323. /// 图文消息项
  324. /// </summary>
  325. public class SendMpNewsItem
  326. {
  327. /// <summary>
  328. /// 标题
  329. /// </summary>
  330. [JsonProperty("title")]
  331. [JsonPropertyName("title")]
  332. public string Title { get; set; }
  333. /// <summary>
  334. /// 缩略图media_id
  335. /// </summary>
  336. [JsonProperty("thumb_media_id")]
  337. [JsonPropertyName("thumb_media_id")]
  338. public string ThumbMediaId { get; set; }
  339. /// <summary>
  340. /// 作者
  341. /// </summary>
  342. [JsonProperty("author")]
  343. [JsonPropertyName("author")]
  344. public string Author { get; set; }
  345. /// <summary>
  346. /// 点击“阅读原文”之后的页面链接
  347. /// </summary>
  348. [JsonProperty("content_source_url")]
  349. [JsonPropertyName("content_source_url")]
  350. public string ContentSourceUrl { get; set; }
  351. /// <summary>
  352. /// 图文消息的内容
  353. /// </summary>
  354. [JsonProperty("content")]
  355. [JsonPropertyName("content")]
  356. public string Content { get; set; }
  357. /// <summary>
  358. /// 图文消息的描述
  359. /// </summary>
  360. [JsonProperty("digest")]
  361. [JsonPropertyName("digest")]
  362. public string Digest { get; set; }
  363. }
  364. /// <summary>
  365. /// 推送图文消息(存储在企业微信)输入参数
  366. /// </summary>
  367. public class SendMpNewsAppChatInput : SendBaseAppChatInput
  368. {
  369. /// <summary>
  370. /// 消息内容
  371. /// </summary>
  372. [JsonProperty("mpnews")]
  373. [JsonPropertyName("mpnews")]
  374. public object MpNews { get; set; }
  375. /// <summary>
  376. /// 图文消息
  377. /// </summary>
  378. /// <param name="chatId"></param>
  379. /// <param name="mpNewsList">图文消息列表</param>
  380. /// <param name="safe"></param>
  381. public SendMpNewsAppChatInput(string chatId, List<SendMpNewsItem> mpNewsList, bool safe = false) : base(chatId, "mpnews", safe)
  382. {
  383. MpNews = new { articles = mpNewsList };
  384. }
  385. }