typings.d.ts 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189
  1. declare namespace API {
  2. type AddAppDto = {
  3. /** 应用名称 */
  4. appName: string;
  5. /** 应用编码 */
  6. appId: string;
  7. };
  8. type AddAppRobotCommandDto = {
  9. /** 应用编码 */
  10. appId: string;
  11. /** 机器人编码 */
  12. robotCode: string;
  13. /** 命令 */
  14. command: string;
  15. /** 应用方接口 */
  16. url: string;
  17. /** 说明 */
  18. description?: string;
  19. };
  20. type AddAppRobotDto = {
  21. /** 应用编码 */
  22. appId: string;
  23. /** 机器人编码 */
  24. robotCodes: string[];
  25. };
  26. type AddAppSftpDto = {
  27. /** 应用编码 */
  28. appId: string;
  29. /** sftp id */
  30. sftpId: string;
  31. /** 主机 */
  32. host: string;
  33. /** 端口 */
  34. port: number;
  35. /** 用户名 */
  36. username: string;
  37. /** 密码 */
  38. password: string;
  39. };
  40. type AddAppTaskDto = {
  41. /** 应用编码 */
  42. appId: string;
  43. /** 任务名称 */
  44. taskName: string;
  45. /** 任务描述 */
  46. description?: string;
  47. /** cron表达式 */
  48. cron: string;
  49. /** 机器人编码 */
  50. robotCode: string;
  51. /** 会话类型:1:单聊,2:群聊 */
  52. conversationType: number;
  53. /** 群id */
  54. openConversationId?: string;
  55. /** 接收机器人消息的用户的手机号列表 */
  56. phones?: string;
  57. /** 接收机器人消息的用户的userId列表 */
  58. userIds?: string;
  59. /** sftp id */
  60. sftpId: string;
  61. /** 数据主文件夹 */
  62. masterDir: string;
  63. /** 是否有子文件夹,0否1是 */
  64. hasSubdirectory: number;
  65. /** 子文件夹匹配方式 */
  66. subdirectoryMethod?: 'MONTH' | 'DAY' | 'REG_EXP';
  67. /** 子文件夹时延 */
  68. dirTimeDelay?: number;
  69. /** 匹配最新子文件夹正则表达式 */
  70. subdirectoryPattern?: string;
  71. /** 文件是否转为文本,0否1是 */
  72. fileToText: number;
  73. /** 文件匹配方式 */
  74. fileMethod: 'ALL' | 'MONTH' | 'DAY' | 'REG_EXP';
  75. /** 文件时延 */
  76. fileTimeDelay?: number;
  77. /** 文件前缀 */
  78. filePrefix?: string;
  79. /** 文件扩展名 */
  80. fileExtension?: string;
  81. /** 文件名匹配正则表达式 */
  82. filePattern?: string;
  83. /** 任务超时时间秒 */
  84. taskTimeout: number;
  85. /** 最大失败重试次数 */
  86. maxRetryTimes: number;
  87. /** 重试间隔秒 */
  88. retryInterval: number;
  89. /** 告警方式 */
  90. alertType: 'DEFAULT' | 'TASK' | 'CUSTOM';
  91. /** 告警机器人编码 */
  92. alertRobotCode?: string;
  93. /** 告警群id */
  94. alertOpenConversationId?: string;
  95. /** 接收告警的手机号列表 */
  96. alertPhones?: string;
  97. /** 接收告警的用户的userId列表 */
  98. alertUserIds?: string;
  99. };
  100. type AddRobotDto = {
  101. /** 机器人编码 */
  102. robotCode: string;
  103. /** 机器人密钥 */
  104. robotSecret: string;
  105. /** 机器人名称 */
  106. robotName: string;
  107. };
  108. type AlertConfigDto = {
  109. /** 机器人编码 */
  110. robotCode?: string;
  111. /** 机器人密钥 */
  112. robotSecret?: string;
  113. /** 群id */
  114. openConversationId?: string;
  115. /** 接收机器人消息的用户的手机号列表 */
  116. phones?: string;
  117. /** 接收机器人消息的用户的userId列表 */
  118. userIds?: string;
  119. };
  120. type AlertConfigPo = {
  121. id?: number;
  122. /** 机器人编码 */
  123. robotCode?: string;
  124. /** 机器人密钥 */
  125. robotSecret?: string;
  126. /** 群id */
  127. openConversationId?: string;
  128. /** 接收机器人消息的用户的手机号列表 */
  129. phones?: string;
  130. /** 接收机器人消息的用户的userId列表 */
  131. userIds?: string;
  132. };
  133. type AppTaskLogPo = {
  134. /** 日志id */
  135. id?: string;
  136. /** 任务id */
  137. taskId?: string;
  138. /** 任务名称 */
  139. taskName?: string;
  140. /** 应用编码 */
  141. appId?: string;
  142. /** 应用名称 */
  143. appName?: string;
  144. /** 机器人编码 */
  145. robotCode?: string;
  146. /** 机器人名称 */
  147. robotName?: string;
  148. /** 会话类型:1:单聊,2:群聊 */
  149. conversationType?: number;
  150. /** 群id */
  151. openConversationId?: string;
  152. /** 接收机器人消息的用户的手机号列表 */
  153. phones?: string;
  154. /** 接收机器人消息的用户的userId列表 */
  155. userIds?: string;
  156. /** sftp id */
  157. sftpId?: string;
  158. /** sftp ip */
  159. host?: string;
  160. /** sftp端口 */
  161. port?: number;
  162. /** 要发送的文件 */
  163. files?: string;
  164. /** 任务执行状态,0失败1成功 */
  165. status?: number;
  166. /** 详情 */
  167. detail?: string;
  168. /** 执行时间 */
  169. createTime?: string;
  170. /** 消息id列表 */
  171. processQueryKeys?: string;
  172. };
  173. type BatchRecallOtoMessagesDto = {
  174. /** 机器人的编码 */
  175. robotCode: string;
  176. /** 消息唯一标识列表,每次最多传20个,在发送消息24小时内可以通过processQueryKey撤回消息,超过24小时则无法撤回消息 */
  177. processQueryKeys: string[];
  178. };
  179. type BatchRecallOtoMessagesVo = {
  180. /** 撤回成功的消息发送任务ID列表 */
  181. successResult?: string[];
  182. /** 撤回失败的消息发送任务ID列表及对应的失败原因 */
  183. failedResult?: Record<string, any>;
  184. };
  185. type BatchSendOtoSampleFileDto = {
  186. /** 机器人的编码 */
  187. robotCode: string;
  188. /** 媒体文件上传后获取的唯一标识 */
  189. mediaId: string;
  190. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  191. phones?: string[];
  192. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  193. userIds?: string[];
  194. /** 文件名 */
  195. filename: string;
  196. };
  197. type BatchSendOtoSampleImageMsgDto = {
  198. /** 机器人的编码 */
  199. robotCode: string;
  200. /** 媒体文件上传后获取的唯一标识 */
  201. mediaId: string;
  202. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  203. phones?: string[];
  204. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  205. userIds?: string[];
  206. };
  207. type BatchSendSampleMarkdownDto = {
  208. /** 标题 */
  209. title: string;
  210. /** 内容 */
  211. text: string;
  212. /** 机器人的编码 */
  213. robotCode: string;
  214. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  215. phones?: string[];
  216. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  217. userIds?: string[];
  218. };
  219. type BatchSendSampleTextDto = {
  220. /** 内容 */
  221. content: string;
  222. /** 机器人的编码 */
  223. robotCode: string;
  224. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  225. phones?: string[];
  226. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  227. userIds?: string[];
  228. };
  229. type BatchSendVo = {
  230. /** 消息id,根据此id,可用于查询消息是否已读和撤回消息 */
  231. processQueryKey?: string;
  232. /** 失败的手机号列表和对应原因 */
  233. failPhones?: Record<string, any>;
  234. /** 无效的用户userId列表 */
  235. invalidStaffIdList?: string[];
  236. /** 被限流的userId列表 */
  237. flowControlledStaffIdList?: string[];
  238. };
  239. type DeleteAppDto = {
  240. /** 应用编码 */
  241. appId: string;
  242. };
  243. type DeleteAppRobotCommandDto = {
  244. /** 应用编码 */
  245. appId: string;
  246. /** 机器人编码 */
  247. robotCode: string;
  248. /** 命令 */
  249. command: string;
  250. };
  251. type DeleteAppRobotDto = {
  252. /** 应用编码 */
  253. appId: string;
  254. /** 机器人编码 */
  255. robotCodes: string[];
  256. };
  257. type DeleteAppSftpDto = {
  258. /** sftp id */
  259. sftpId: string;
  260. };
  261. type DeleteAppTaskDto = {
  262. /** 任务id */
  263. taskId: string;
  264. };
  265. type DeleteRobotDto = {
  266. /** 机器人编码 */
  267. robotCode: string;
  268. };
  269. type EnableAppTaskDto = {
  270. /** 任务id */
  271. taskId: string;
  272. };
  273. type GetAppRobotOptionsDto = {
  274. /** 应用编码 */
  275. appId: string;
  276. };
  277. type GetAppRobotOptionsVo = {
  278. /** 机器人编码 */
  279. value?: string;
  280. /** 机器人名称 */
  281. label?: string;
  282. };
  283. type GetAppSftpOptionsDto = {
  284. /** 应用编码 */
  285. appId: string;
  286. };
  287. type GetAppSftpOptionsVo = {
  288. /** sftp id */
  289. value?: string;
  290. /** sftp信息 */
  291. label?: string;
  292. };
  293. type GetUserIdByMobileDto = {
  294. /** 机器人的编码 */
  295. robotCode: string;
  296. /** 用户的手机号 */
  297. mobile: string;
  298. };
  299. type GetUserIdByMobileVo = {
  300. /** 员工的userId */
  301. userId?: string;
  302. };
  303. type GroupSendSampleFileDto = {
  304. /** 机器人的编码 */
  305. robotCode: string;
  306. /** 会话ID */
  307. openConversationId: string;
  308. /** 媒体文件上传后获取的唯一标识 */
  309. mediaId: string;
  310. /** 文件名 */
  311. filename: string;
  312. };
  313. type GroupSendSampleImageMsgDto = {
  314. /** 机器人的编码 */
  315. robotCode: string;
  316. /** 会话ID */
  317. openConversationId: string;
  318. /** 媒体文件上传后获取的唯一标识 */
  319. mediaId: string;
  320. };
  321. type GroupSendSampleMarkdownDto = {
  322. /** 标题 */
  323. title: string;
  324. /** 内容 */
  325. text: string;
  326. /** 机器人的编码 */
  327. robotCode: string;
  328. /** 会话ID */
  329. openConversationId: string;
  330. };
  331. type GroupSendSampleTextDto = {
  332. /** 内容 */
  333. content: string;
  334. /** 机器人的编码 */
  335. robotCode: string;
  336. /** 会话ID */
  337. openConversationId: string;
  338. };
  339. type GroupSendVo = {
  340. /** 加密消息id,根据此id可查询消息已读状态和撤回消息 */
  341. processQueryKey?: string;
  342. };
  343. type ListAppDto = {
  344. /** 页码>=1 */
  345. current: number;
  346. /** 每页个数,[1,100] */
  347. pageSize: number;
  348. /** 应用名称 */
  349. appName?: string;
  350. /** 应用编码 */
  351. appId?: string;
  352. /** 排序 */
  353. sort?: Record<string, any>;
  354. };
  355. type ListAppRobotCommandDto = {
  356. /** 页码>=1 */
  357. current: number;
  358. /** 每页个数,[1,100] */
  359. pageSize: number;
  360. /** 应用编码 */
  361. appId: string;
  362. /** 机器人编码 */
  363. robotCode: string;
  364. /** 命令 */
  365. command?: string;
  366. /** 排序 */
  367. sort?: Record<string, any>;
  368. };
  369. type ListAppRobotCommandVo = {
  370. /** 命令 */
  371. command?: string;
  372. /** 应用方接口 */
  373. url?: string;
  374. /** 说明 */
  375. description?: string;
  376. /** 创建时间 */
  377. createTime?: string;
  378. /** 更新时间 */
  379. updateTime?: string;
  380. };
  381. type ListAppRobotDto = {
  382. /** 页码>=1 */
  383. current: number;
  384. /** 每页个数,[1,100] */
  385. pageSize: number;
  386. /** 应用编码 */
  387. appId: string;
  388. /** 机器人编码 */
  389. robotCode?: string;
  390. /** 机器人名称 */
  391. robotName?: string;
  392. /** 排序 */
  393. sort?: Record<string, any>;
  394. };
  395. type ListAppRobotVo = {
  396. /** 机器人编码 */
  397. robotCode?: string;
  398. /** 机器人密钥 */
  399. robotSecret?: string;
  400. /** 机器人名称 */
  401. robotName?: string;
  402. };
  403. type ListAppSftpDto = {
  404. /** 页码>=1 */
  405. current: number;
  406. /** 每页个数,[1,100] */
  407. pageSize: number;
  408. /** 应用编码 */
  409. appId: string;
  410. /** sftp id */
  411. sftpId?: string;
  412. /** 主机 */
  413. host?: string;
  414. /** 端口 */
  415. port?: number;
  416. /** 用户名 */
  417. username?: string;
  418. /** 排序 */
  419. sort?: Record<string, any>;
  420. };
  421. type ListAppSftpVo = {
  422. /** sftp id */
  423. sftpId?: string;
  424. /** 应用编码 */
  425. appId?: string;
  426. /** 主机 */
  427. host?: string;
  428. /** 端口 */
  429. port?: number;
  430. /** 用户名 */
  431. username?: string;
  432. /** 密码 */
  433. password?: string;
  434. /** 创建时间 */
  435. createTime?: string;
  436. /** 更新时间 */
  437. updateTime?: string;
  438. };
  439. type ListAppTaskDto = {
  440. /** 页码>=1 */
  441. current: number;
  442. /** 每页个数,[1,100] */
  443. pageSize: number;
  444. /** 应用编码 */
  445. appId: string;
  446. /** 任务id */
  447. taskId?: string;
  448. /** 任务名称 */
  449. taskName?: string;
  450. /** 任务状态,0已停止1运行中2已删除 */
  451. status?: number;
  452. /** 机器人编码 */
  453. robotCode?: string;
  454. /** 机器人名称 */
  455. robotName?: string;
  456. /** 会话类型:1:单聊,2:群聊 */
  457. conversationType?: number;
  458. /** 群id */
  459. openConversationId?: string;
  460. /** 接收机器人消息的用户的手机号列表 */
  461. phones?: string;
  462. /** 接收机器人消息的用户的userId列表 */
  463. userIds?: string;
  464. /** sftp id */
  465. sftpId?: string;
  466. /** 主机 */
  467. host?: string;
  468. /** 排序 */
  469. sort?: Record<string, any>;
  470. };
  471. type ListAppTaskLogDto = {
  472. /** 页码>=1 */
  473. current: number;
  474. /** 每页个数,[1,100] */
  475. pageSize: number;
  476. /** 日志id */
  477. id?: string;
  478. /** 应用编码 */
  479. appId?: string;
  480. /** 应用名称 */
  481. appName?: string;
  482. /** 任务id */
  483. taskId?: string;
  484. /** 任务名称 */
  485. taskName?: string;
  486. /** 任务执行状态,0失败1成功 */
  487. status?: number;
  488. /** 机器人编码 */
  489. robotCode?: string;
  490. /** 机器人名称 */
  491. robotName?: string;
  492. /** 会话类型:1:单聊,2:群聊 */
  493. conversationType?: number;
  494. /** 群id */
  495. openConversationId?: string;
  496. /** 接收机器人消息的用户的手机号列表 */
  497. phones?: string;
  498. /** 接收机器人消息的用户的userId列表 */
  499. userIds?: string;
  500. /** sftp id */
  501. sftpId?: string;
  502. /** 主机 */
  503. host?: string;
  504. /** 开始时间 */
  505. startTime?: string;
  506. /** 结束时间 */
  507. endTime?: string;
  508. /** 排序 */
  509. sort?: Record<string, any>;
  510. };
  511. type ListAppTaskVo = {
  512. /** 应用编码 */
  513. appId?: string;
  514. /** 应用名称 */
  515. appName?: string;
  516. /** 任务id */
  517. taskId?: string;
  518. /** 任务名称 */
  519. taskName?: string;
  520. /** 任务描述 */
  521. description?: string;
  522. /** 任务状态,0已停止1运行中2已删除 */
  523. status?: number;
  524. /** cron表达式 */
  525. cron?: string;
  526. /** 机器人编码 */
  527. robotCode?: string;
  528. /** 机器人名称 */
  529. robotName?: string;
  530. /** 会话类型:1:单聊,2:群聊 */
  531. conversationType?: number;
  532. /** 群id */
  533. openConversationId?: string;
  534. /** 接收机器人消息的用户的手机号列表 */
  535. phones?: string;
  536. /** 接收机器人消息的用户的userId列表 */
  537. userIds?: string;
  538. /** sftp id */
  539. sftpId?: string;
  540. /** 主机 */
  541. host?: string;
  542. /** 数据主文件夹 */
  543. masterDir?: string;
  544. /** 是否有子文件夹,0否1是 */
  545. hasSubdirectory?: number;
  546. /** 子文件夹匹配方式 */
  547. subdirectoryMethod?: string;
  548. /** 子文件夹时延 */
  549. dirTimeDelay?: number;
  550. /** 匹配最新子文件夹正则表达式 */
  551. subdirectoryPattern?: string;
  552. /** 文件是否转为文本,0否1是 */
  553. fileToText?: number;
  554. /** 文件匹配方式 */
  555. fileMethod?: string;
  556. /** 文件时延 */
  557. fileTimeDelay?: number;
  558. /** 文件前缀 */
  559. filePrefix?: string;
  560. /** 文件扩展名 */
  561. fileExtension?: string;
  562. /** 文件名匹配正则表达式 */
  563. filePattern?: string;
  564. /** 任务超时时间秒 */
  565. taskTimeout?: number;
  566. /** 失败重试次数 */
  567. maxRetryTimes?: number;
  568. /** 重试间隔秒 */
  569. retryInterval?: number;
  570. /** 告警方式 */
  571. alertType?: string;
  572. /** 告警机器人名称 */
  573. alertRobotName?: string;
  574. /** 告警机器人编码 */
  575. alertRobotCode?: string;
  576. /** 告警群id */
  577. alertOpenConversationId?: string;
  578. /** 接收告警的手机号列表 */
  579. alertPhones?: string;
  580. /** 接收告警的用户的userId列表 */
  581. alertUserIds?: string;
  582. /** 创建时间 */
  583. createTime?: string;
  584. /** 更新时间 */
  585. updateTime?: string;
  586. };
  587. type ListAppVo = {
  588. /** 应用编码 */
  589. appId?: string;
  590. /** 应用名称 */
  591. appName?: string;
  592. /** 应用密钥 */
  593. appSecret?: string;
  594. /** 创建时间 */
  595. createTime?: string;
  596. /** 更新时间 */
  597. updateTime?: string;
  598. };
  599. type ListAvailableRobotDto = {
  600. /** 页码>=1 */
  601. current: number;
  602. /** 每页个数,[1,100] */
  603. pageSize: number;
  604. /** 应用编码 */
  605. appId: string;
  606. /** 机器人编码 */
  607. robotCode?: string;
  608. /** 机器人名称 */
  609. robotName?: string;
  610. /** 排序 */
  611. sort?: Record<string, any>;
  612. };
  613. type ListAvailableRobotVo = {
  614. /** 机器人编码 */
  615. robotCode?: string;
  616. /** 机器人密钥 */
  617. robotSecret?: string;
  618. /** 机器人名称 */
  619. robotName?: string;
  620. };
  621. type ListRobotDto = {
  622. /** 页码>=1 */
  623. current: number;
  624. /** 每页个数,[1,100] */
  625. pageSize: number;
  626. /** 机器人编码 */
  627. robotCode?: string;
  628. /** 机器人名称 */
  629. robotName?: string;
  630. /** 排序 */
  631. sort?: Record<string, any>;
  632. };
  633. type ListRobotVo = {
  634. /** 机器人编码 */
  635. robotCode?: string;
  636. /** 机器人密钥 */
  637. robotSecret?: string;
  638. /** 机器人名称 */
  639. robotName?: string;
  640. /** 创建时间 */
  641. createTime?: string;
  642. /** 更新时间 */
  643. updateTime?: string;
  644. };
  645. type LoginDto = {
  646. /** 用户名 */
  647. username: string;
  648. /** 密码 */
  649. password: string;
  650. };
  651. type loginParams = {
  652. dto: LoginDto;
  653. };
  654. type LoginVo = {
  655. /** 用户名 */
  656. name?: string;
  657. /** 头像 */
  658. avatar?: string;
  659. };
  660. type PageVoAppTaskLogPo = {
  661. /** 总数 */
  662. total?: number;
  663. /** 列表 */
  664. list?: AppTaskLogPo[];
  665. };
  666. type PageVoListAppRobotCommandVo = {
  667. /** 总数 */
  668. total?: number;
  669. /** 列表 */
  670. list?: ListAppRobotCommandVo[];
  671. };
  672. type PageVoListAppRobotVo = {
  673. /** 总数 */
  674. total?: number;
  675. /** 列表 */
  676. list?: ListAppRobotVo[];
  677. };
  678. type PageVoListAppSftpVo = {
  679. /** 总数 */
  680. total?: number;
  681. /** 列表 */
  682. list?: ListAppSftpVo[];
  683. };
  684. type PageVoListAppTaskVo = {
  685. /** 总数 */
  686. total?: number;
  687. /** 列表 */
  688. list?: ListAppTaskVo[];
  689. };
  690. type PageVoListAppVo = {
  691. /** 总数 */
  692. total?: number;
  693. /** 列表 */
  694. list?: ListAppVo[];
  695. };
  696. type PageVoListAvailableRobotVo = {
  697. /** 总数 */
  698. total?: number;
  699. /** 列表 */
  700. list?: ListAvailableRobotVo[];
  701. };
  702. type PageVoListRobotVo = {
  703. /** 总数 */
  704. total?: number;
  705. /** 列表 */
  706. list?: ListRobotVo[];
  707. };
  708. type RAlertConfigPo = {
  709. /** 是否成功 */
  710. success?: boolean;
  711. /** 错误码 */
  712. code?: number;
  713. /** 提示信息 */
  714. message?: string;
  715. data?: AlertConfigPo;
  716. /** 请求跟踪id */
  717. traceId?: string;
  718. };
  719. type RBatchRecallOtoMessagesVo = {
  720. /** 是否成功 */
  721. success?: boolean;
  722. /** 错误码 */
  723. code?: number;
  724. /** 提示信息 */
  725. message?: string;
  726. data?: BatchRecallOtoMessagesVo;
  727. /** 请求跟踪id */
  728. traceId?: string;
  729. };
  730. type RBatchSendVo = {
  731. /** 是否成功 */
  732. success?: boolean;
  733. /** 错误码 */
  734. code?: number;
  735. /** 提示信息 */
  736. message?: string;
  737. data?: BatchSendVo;
  738. /** 请求跟踪id */
  739. traceId?: string;
  740. };
  741. type RecallGroupMessagesDto = {
  742. /** 机器人的编码 */
  743. robotCode: string;
  744. /** 会话ID */
  745. openConversationId: string;
  746. /** 消息唯一标识列表,每次最多传20个,在发送消息24小时内可以通过processQueryKey撤回消息,超过24小时则无法撤回消息 */
  747. processQueryKeys: string[];
  748. };
  749. type RecallGroupMessagesVo = {
  750. /** 撤回成功的消息发送任务ID列表 */
  751. successResult?: string[];
  752. /** 撤回失败的消息发送任务ID列表及对应的失败原因 */
  753. failedResult?: Record<string, any>;
  754. };
  755. type ResetAppSecretDto = {
  756. /** 应用编码 */
  757. appId: string;
  758. };
  759. type RGetUserIdByMobileVo = {
  760. /** 是否成功 */
  761. success?: boolean;
  762. /** 错误码 */
  763. code?: number;
  764. /** 提示信息 */
  765. message?: string;
  766. data?: GetUserIdByMobileVo;
  767. /** 请求跟踪id */
  768. traceId?: string;
  769. };
  770. type RGroupSendVo = {
  771. /** 是否成功 */
  772. success?: boolean;
  773. /** 错误码 */
  774. code?: number;
  775. /** 提示信息 */
  776. message?: string;
  777. data?: GroupSendVo;
  778. /** 请求跟踪id */
  779. traceId?: string;
  780. };
  781. type RListGetAppRobotOptionsVo = {
  782. /** 是否成功 */
  783. success?: boolean;
  784. /** 错误码 */
  785. code?: number;
  786. /** 提示信息 */
  787. message?: string;
  788. /** 数据 */
  789. data?: GetAppRobotOptionsVo[];
  790. /** 请求跟踪id */
  791. traceId?: string;
  792. };
  793. type RListGetAppSftpOptionsVo = {
  794. /** 是否成功 */
  795. success?: boolean;
  796. /** 错误码 */
  797. code?: number;
  798. /** 提示信息 */
  799. message?: string;
  800. /** 数据 */
  801. data?: GetAppSftpOptionsVo[];
  802. /** 请求跟踪id */
  803. traceId?: string;
  804. };
  805. type RLoginVo = {
  806. /** 是否成功 */
  807. success?: boolean;
  808. /** 错误码 */
  809. code?: number;
  810. /** 提示信息 */
  811. message?: string;
  812. data?: LoginVo;
  813. /** 请求跟踪id */
  814. traceId?: string;
  815. };
  816. type RObject = {
  817. /** 是否成功 */
  818. success?: boolean;
  819. /** 错误码 */
  820. code?: number;
  821. /** 提示信息 */
  822. message?: string;
  823. /** 数据 */
  824. data?: Record<string, any>;
  825. /** 请求跟踪id */
  826. traceId?: string;
  827. };
  828. type RPageVoAppTaskLogPo = {
  829. /** 是否成功 */
  830. success?: boolean;
  831. /** 错误码 */
  832. code?: number;
  833. /** 提示信息 */
  834. message?: string;
  835. data?: PageVoAppTaskLogPo;
  836. /** 请求跟踪id */
  837. traceId?: string;
  838. };
  839. type RPageVoListAppRobotCommandVo = {
  840. /** 是否成功 */
  841. success?: boolean;
  842. /** 错误码 */
  843. code?: number;
  844. /** 提示信息 */
  845. message?: string;
  846. data?: PageVoListAppRobotCommandVo;
  847. /** 请求跟踪id */
  848. traceId?: string;
  849. };
  850. type RPageVoListAppRobotVo = {
  851. /** 是否成功 */
  852. success?: boolean;
  853. /** 错误码 */
  854. code?: number;
  855. /** 提示信息 */
  856. message?: string;
  857. data?: PageVoListAppRobotVo;
  858. /** 请求跟踪id */
  859. traceId?: string;
  860. };
  861. type RPageVoListAppSftpVo = {
  862. /** 是否成功 */
  863. success?: boolean;
  864. /** 错误码 */
  865. code?: number;
  866. /** 提示信息 */
  867. message?: string;
  868. data?: PageVoListAppSftpVo;
  869. /** 请求跟踪id */
  870. traceId?: string;
  871. };
  872. type RPageVoListAppTaskVo = {
  873. /** 是否成功 */
  874. success?: boolean;
  875. /** 错误码 */
  876. code?: number;
  877. /** 提示信息 */
  878. message?: string;
  879. data?: PageVoListAppTaskVo;
  880. /** 请求跟踪id */
  881. traceId?: string;
  882. };
  883. type RPageVoListAppVo = {
  884. /** 是否成功 */
  885. success?: boolean;
  886. /** 错误码 */
  887. code?: number;
  888. /** 提示信息 */
  889. message?: string;
  890. data?: PageVoListAppVo;
  891. /** 请求跟踪id */
  892. traceId?: string;
  893. };
  894. type RPageVoListAvailableRobotVo = {
  895. /** 是否成功 */
  896. success?: boolean;
  897. /** 错误码 */
  898. code?: number;
  899. /** 提示信息 */
  900. message?: string;
  901. data?: PageVoListAvailableRobotVo;
  902. /** 请求跟踪id */
  903. traceId?: string;
  904. };
  905. type RPageVoListRobotVo = {
  906. /** 是否成功 */
  907. success?: boolean;
  908. /** 错误码 */
  909. code?: number;
  910. /** 提示信息 */
  911. message?: string;
  912. data?: PageVoListRobotVo;
  913. /** 请求跟踪id */
  914. traceId?: string;
  915. };
  916. type RRecallGroupMessagesVo = {
  917. /** 是否成功 */
  918. success?: boolean;
  919. /** 错误码 */
  920. code?: number;
  921. /** 提示信息 */
  922. message?: string;
  923. data?: RecallGroupMessagesVo;
  924. /** 请求跟踪id */
  925. traceId?: string;
  926. };
  927. type RunAppTaskDto = {
  928. /** 任务id */
  929. taskId: string;
  930. };
  931. type RUploadVo = {
  932. /** 是否成功 */
  933. success?: boolean;
  934. /** 错误码 */
  935. code?: number;
  936. /** 提示信息 */
  937. message?: string;
  938. data?: UploadVo;
  939. /** 请求跟踪id */
  940. traceId?: string;
  941. };
  942. type SftpBatchSendOtoSampleFileDto = {
  943. /** 机器人的编码 */
  944. robotCode: string;
  945. /** sftp id */
  946. sftpId: string;
  947. /** 文件绝对路径 */
  948. filePath: string;
  949. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  950. phones?: string[];
  951. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  952. userIds?: string[];
  953. };
  954. type SftpBatchSendOtoSampleImageMsgDto = {
  955. /** 机器人的编码 */
  956. robotCode: string;
  957. /** sftp id */
  958. sftpId: string;
  959. /** 图片绝对路径 */
  960. filePath: string;
  961. /** 接收机器人消息的用户的手机号列表,每次最多传20个 */
  962. phones?: string[];
  963. /** 接收机器人消息的用户的userId列表,每次最多传20个 */
  964. userIds?: string[];
  965. };
  966. type SftpGroupSendSampleFileDto = {
  967. /** 机器人的编码 */
  968. robotCode: string;
  969. /** 会话ID */
  970. openConversationId: string;
  971. /** sftp id */
  972. sftpId: string;
  973. /** 文件绝对路径 */
  974. filePath: string;
  975. };
  976. type SftpGroupSendSampleImageMsgDto = {
  977. /** 机器人的编码 */
  978. robotCode: string;
  979. /** 会话ID */
  980. openConversationId: string;
  981. /** sftp id */
  982. sftpId: string;
  983. /** 图片绝对路径 */
  984. filePath: string;
  985. };
  986. type StopAppTaskDto = {
  987. /** 任务id */
  988. taskId: string;
  989. };
  990. type UpdateAppDto = {
  991. /** 应用名称 */
  992. appName: string;
  993. /** 应用编码 */
  994. appId: string;
  995. };
  996. type UpdateAppRobotCommandDto = {
  997. /** 应用编码 */
  998. appId: string;
  999. /** 机器人编码 */
  1000. robotCode: string;
  1001. /** 命令 */
  1002. command: string;
  1003. /** 应用方接口 */
  1004. url: string;
  1005. /** 说明 */
  1006. description?: string;
  1007. };
  1008. type UpdateAppSftpDto = {
  1009. /** 应用编码 */
  1010. appId: string;
  1011. /** sftp id */
  1012. sftpId: string;
  1013. /** 主机 */
  1014. host: string;
  1015. /** 端口 */
  1016. port: number;
  1017. /** 用户名 */
  1018. username: string;
  1019. /** 密码 */
  1020. password: string;
  1021. };
  1022. type UpdateAppTaskDto = {
  1023. /** 应用编码 */
  1024. appId: string;
  1025. /** 任务名称 */
  1026. taskName: string;
  1027. /** 任务描述 */
  1028. description?: string;
  1029. /** cron表达式 */
  1030. cron: string;
  1031. /** 机器人编码 */
  1032. robotCode: string;
  1033. /** 会话类型:1:单聊,2:群聊 */
  1034. conversationType: number;
  1035. /** 群id */
  1036. openConversationId?: string;
  1037. /** 接收机器人消息的用户的手机号列表 */
  1038. phones?: string;
  1039. /** 接收机器人消息的用户的userId列表 */
  1040. userIds?: string;
  1041. /** sftp id */
  1042. sftpId: string;
  1043. /** 数据主文件夹 */
  1044. masterDir: string;
  1045. /** 是否有子文件夹,0否1是 */
  1046. hasSubdirectory: number;
  1047. /** 子文件夹匹配方式 */
  1048. subdirectoryMethod?: 'MONTH' | 'DAY' | 'REG_EXP';
  1049. /** 子文件夹时延 */
  1050. dirTimeDelay?: number;
  1051. /** 匹配最新子文件夹正则表达式 */
  1052. subdirectoryPattern?: string;
  1053. /** 文件是否转为文本,0否1是 */
  1054. fileToText: number;
  1055. /** 文件匹配方式 */
  1056. fileMethod: 'ALL' | 'MONTH' | 'DAY' | 'REG_EXP';
  1057. /** 文件时延 */
  1058. fileTimeDelay?: number;
  1059. /** 文件前缀 */
  1060. filePrefix?: string;
  1061. /** 文件扩展名 */
  1062. fileExtension?: string;
  1063. /** 文件名匹配正则表达式 */
  1064. filePattern?: string;
  1065. /** 任务超时时间秒 */
  1066. taskTimeout: number;
  1067. /** 最大失败重试次数 */
  1068. maxRetryTimes: number;
  1069. /** 重试间隔秒 */
  1070. retryInterval: number;
  1071. /** 告警方式 */
  1072. alertType: 'DEFAULT' | 'TASK' | 'CUSTOM';
  1073. /** 告警机器人编码 */
  1074. alertRobotCode?: string;
  1075. /** 告警群id */
  1076. alertOpenConversationId?: string;
  1077. /** 接收告警的手机号列表 */
  1078. alertPhones?: string;
  1079. /** 接收告警的用户的userId列表 */
  1080. alertUserIds?: string;
  1081. /** 任务id */
  1082. taskId: string;
  1083. };
  1084. type UpdateRobotDto = {
  1085. /** 机器人编码 */
  1086. robotCode: string;
  1087. /** 机器人密钥 */
  1088. robotSecret: string;
  1089. /** 机器人名称 */
  1090. robotName: string;
  1091. };
  1092. type UploadVo = {
  1093. /** 媒体文件上传后获取的唯一标识 */
  1094. mediaId?: string;
  1095. };
  1096. }