DingTalkCreateAndDeliverInput.cs 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. namespace Admin.NET.Plugin.DingTalk;
  7. public class DingTalkCreateAndDeliverInput
  8. {
  9. /// <summary>
  10. /// 卡片创建者的userId
  11. /// </summary>
  12. public string? userId { get; set; }
  13. /// <summary>
  14. /// 卡片内容模板ID
  15. /// </summary>
  16. [Required]
  17. public string cardTemplateId { get; set; }
  18. /// <summary>
  19. /// 外部卡片实例Id
  20. /// </summary>
  21. [Required]
  22. public string outTrackId { get; set; }
  23. /// <summary>
  24. /// 卡片回调的类型:STREAM:stream模式 HTTP:http模式
  25. /// </summary>
  26. public string? callbackType { get; set; }
  27. /// <summary>
  28. /// 卡片回调HTTP模式时的路由 Key,用于查询注册的 callbackUrl。
  29. /// </summary>
  30. public string? callbackRouteKey { get; set; }
  31. /// <summary>
  32. /// 卡片数据
  33. /// </summary>
  34. [Required]
  35. public DingTalk_CardData cardData { get; set; }
  36. /// <summary>
  37. /// 用户的私有数据
  38. /// </summary>
  39. public PrivateData? crivateData { get; set; }
  40. /// <summary>
  41. /// 动态数据源配置
  42. /// </summary>
  43. public OpenDynamicDataConfig? openDynamicDataConfig { get; set; }
  44. /// <summary>
  45. /// IM单聊酷应用场域信息
  46. /// </summary>
  47. public OpenSpaceModel? imSingleOpenSpaceModel { get; set; }
  48. /// <summary>
  49. /// IM群聊场域信息。
  50. /// </summary>
  51. public OpenSpaceModel? imGroupOpenSpaceModel { get; set; }
  52. /// <summary>
  53. /// IM机器人单聊场域信息。
  54. /// </summary>
  55. public OpenSpaceModel? imRobotOpenSpaceModel { get; set; }
  56. /// <summary>
  57. /// 协作场域信息
  58. /// </summary>
  59. public OpenSpaceModel? coFeedOpenSpaceModel { get; set; }
  60. /// <summary>
  61. /// 吊顶场域信息
  62. /// </summary>
  63. public OpenSpaceModel? topOpenSpaceModel { get; set; }
  64. /// <summary>
  65. /// 表示场域及其场域id
  66. /// </summary>
  67. /// <remarks>
  68. /// 其格式为dtv1.card//spaceType1.spaceId1;spaceType2.spaceId2_1;spaceType2.spaceId2_2;spaceType3.spaceId3
  69. /// </remarks>
  70. [Required]
  71. public string openSpaceId { get; set; }
  72. /// <summary>
  73. /// 单聊酷应用场域投放参数。
  74. /// </summary>
  75. public DingTalkOpenDeliverModel? imSingleOpenDeliverModel { get; set; }
  76. /// <summary>
  77. /// 群聊投放参数。
  78. /// </summary>
  79. public DingTalkOpenDeliverModel? imGroupOpenDeliverModel { get; set; }
  80. /// <summary>
  81. /// IM机器人单聊投放参数。
  82. /// </summary>
  83. public DingTalkOpenDeliverModel? imRobotOpenDeliverModel { get; set; }
  84. /// <summary>
  85. /// 吊顶投放参数。
  86. /// </summary>
  87. public DingTalkOpenDeliverModel? topOpenDeliverModel { get; set; }
  88. /// <summary>
  89. /// 协作投放参数。
  90. /// </summary>
  91. public DingTalkOpenDeliverModel? coFeedOpenDeliverModel { get; set; }
  92. /// <summary>
  93. /// 文档投放参数
  94. /// </summary>
  95. public DingTalkOpenDeliverModel? docOpenDeliverModel { get; set; }
  96. /// <summary>
  97. /// 用户userId类型:1(默认):userId模式 2:unionId模式
  98. /// </summary>
  99. public int UserIdType { get; set; }
  100. }
  101. public class DingTalk_CardData
  102. {
  103. public DingTalk_CardParamMap cardParamMap { get; set; }
  104. }
  105. /// <summary>
  106. /// 卡片模板内容替换参数
  107. /// </summary>
  108. public class DingTalk_CardParamMap
  109. {
  110. /// <summary>
  111. /// 片模板内容替换参数
  112. /// </summary>
  113. [Newtonsoft.Json.JsonProperty("sys_full_json_obj")]
  114. [System.Text.Json.Serialization.JsonPropertyName("sys_full_json_obj")]
  115. public string sysFullJsonObj { get; set; }
  116. }
  117. public class PrivateData
  118. {
  119. public Dictionary<string, DingTalk_CardParamMap> key { get; set; } = new Dictionary<string, DingTalk_CardParamMap>();
  120. }
  121. public class OpenDynamicDataConfig
  122. {
  123. /// <summary>
  124. /// 动态数据源配置列表。
  125. /// </summary>
  126. public List<DynamicDataSourceConfig>? dynamicDataSourceConfigs { get; set; }
  127. }
  128. public class DynamicDataSourceConfig
  129. {
  130. /// <summary>
  131. /// 数据源的唯一 ID, 调用方指定。
  132. /// </summary>
  133. public string? dynamicDataSourceId { get; set; }
  134. /// <summary>
  135. /// 回调数据源时回传的固定参数。 示例
  136. /// </summary>
  137. public Dictionary<string, string>? constParams { get; set; }
  138. /// <summary>
  139. /// 数据源拉取配置。
  140. /// </summary>
  141. public PullConfig? pullConfig { get; set; }
  142. }
  143. public class PullConfig
  144. {
  145. /// <summary>
  146. /// 拉取策略,可选值:NONE:不拉取,无动态数据 INTERVAL:间隔拉取ONCE:只拉取一次
  147. /// </summary>
  148. public string pullStrategy { get; set; }
  149. /// <summary>
  150. /// 拉取的间隔时间。
  151. /// </summary>
  152. public int interval { get; set; }
  153. /// <summary>
  154. /// 拉取的间隔时间的单位, 可选值:SECONDS:秒 MINUTES:分钟 HOURS:小时 DAYS:天
  155. /// </summary>
  156. public string timeUnit { get; set; }
  157. }
  158. public class OpenSpaceModel
  159. {
  160. /// <summary>
  161. /// 吊顶场域属性,通过增加spaeType使卡片支持吊顶场域。
  162. /// </summary>
  163. public string? spaceType { get; set; }
  164. /// <summary>
  165. /// 卡片标题。
  166. /// </summary>
  167. public string? title { get; set; }
  168. /// <summary>
  169. /// 酷应用编码。
  170. /// </summary>
  171. public string? coolAppCode { get; set; }
  172. /// <summary>
  173. /// 是否支持转发, 默认false。
  174. /// </summary>
  175. public bool? supportForward { get; set; }
  176. /// <summary>
  177. /// 支持国际化的LastMessage。
  178. /// </summary>
  179. public Dictionary<string, string>? lastMessageI18n { get; set; }
  180. /// <summary>
  181. /// 支持卡片消息可被搜索字段。
  182. /// </summary>
  183. public SearchSupport? searchSupport { get; set; }
  184. /// <summary>
  185. /// 通知信息。
  186. /// </summary>
  187. public Notification? notification { get; set; }
  188. }
  189. public class SearchSupport
  190. {
  191. /// <summary>
  192. /// 类型的icon,供搜索展示使用。
  193. /// </summary>
  194. public string searchIcon { get; set; }
  195. /// <summary>
  196. /// 卡片类型名。
  197. /// </summary>
  198. public string searchTypeName { get; set; }
  199. /// <summary>
  200. /// 供消息展示与搜索的字段。
  201. /// </summary>
  202. public string searchDesc { get; set; }
  203. }
  204. public class Notification
  205. {
  206. /// <summary>
  207. /// 供消息展示与搜索的字段。
  208. /// </summary>
  209. public string alertContent { get; set; }
  210. /// <summary>
  211. /// 是否关闭推送通知:true:关闭 false:不关闭
  212. /// </summary>
  213. public bool notificationOff { get; set; }
  214. }
  215. public class DingTalkOpenDeliverModel
  216. {
  217. /// <summary>
  218. /// 用于发送卡片的机器人编码。
  219. /// </summary>
  220. public string robotCode { get; set; }
  221. /// <summary>
  222. /// 消息@人。格式:{"key":"value"}。key:用户的userId value:用户名
  223. /// </summary>
  224. public Dictionary<string, string> atUserIds { get; set; }
  225. /// <summary>
  226. /// 指定接收人的userId。
  227. /// </summary>
  228. public List<string> recipients { get; set; }
  229. /// <summary>
  230. /// 扩展字段,示例如下:{"key":"value"}
  231. /// </summary>
  232. public Dictionary<string, string> extension { get; set; }
  233. /// <summary>
  234. /// IM机器人单聊若未设置其他投放属性,需设置spaeType为IM_ROBOT。
  235. /// </summary>
  236. public string spaceType { get; set; }
  237. /// <summary>
  238. /// 过期时间戳。若使用topOpenDeliverModel对象,则该字段必填。
  239. /// </summary>
  240. public long expiredTimeMillis { get; set; }
  241. /// <summary>
  242. /// 可以查看该吊顶卡片的userId。
  243. /// </summary>
  244. public List<string> userIds { get; set; }
  245. /// <summary>
  246. /// 可以查看该吊顶卡片的设备:android|ios|win|mac。
  247. /// </summary>
  248. public List<string> platforms { get; set; }
  249. /// <summary>
  250. /// 业务标识。
  251. /// </summary>
  252. public string bizTag { get; set; }
  253. /// <summary>
  254. /// 协作场域下的排序时间。
  255. /// </summary>
  256. public long gmtTimeLine { get; set; }
  257. /// <summary>
  258. /// 员工userId信息
  259. /// </summary>
  260. public string userId { get; set; }
  261. }