create.d.ts 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. /**
  2. * 打开DING、任务、会议界面 请求参数定义
  3. * @apiName biz.ding.create
  4. */
  5. export interface IBizDingCreateParams {
  6. /** 用户列表,工号 */
  7. users: string[];
  8. /** 企业id */
  9. corpId: string;
  10. /** 附件类型 1:image 2:link */
  11. type?: 1 | 2;
  12. /** 钉发送方式 0:电话, 1:短信, 2:应用内 */
  13. alertType?: 0 | 1 | 2;
  14. alertDate?: {
  15. /** yyyy-MM-dd HH:mm */
  16. format: string;
  17. /** 2015-05-09 08:00 */
  18. value: string;
  19. };
  20. /** 附件信息 */
  21. attachment?: {
  22. images: string[];
  23. } | {
  24. title: string;
  25. url: string;
  26. image: string;
  27. text: string;
  28. };
  29. /** 正文 */
  30. text?: string;
  31. /** 业务类型 0:通知DING;1:任务;2:会议; */
  32. bizType?: 0 | 1 | 2;
  33. /** 会议信息 */
  34. confInfo?: {
  35. /** 子业务类型如会议:0:预约会议;1:预约电话会议;2:预约视频会议;(注:目前只有会议才有子业务类型) */
  36. bizSubType: 0 | 1 | 2;
  37. /** 会议地点;(非必填) */
  38. location?: string;
  39. /** 会议开始时间 */
  40. startTime?: {
  41. /** yyyy-MM-dd HH:mm */
  42. format: string;
  43. /** 2015-05-09 08:00 */
  44. value: string;
  45. };
  46. /** 会议结束时间 */
  47. endTime?: {
  48. /** yyyy-MM-dd HH:mm */
  49. format: string;
  50. /** 2015-05-09 08:00 */
  51. value: string;
  52. };
  53. /** 会前提醒。单位分钟-1:不提醒;0:事件发生时提醒;5:提前5分钟;15:提前15分钟;30:提前30分钟;60:提前1个小时;1440:提前一天; */
  54. remindMinutes?: number;
  55. /** 会议提前提醒方式。0:电话, 1:短信, 2:应用内 */
  56. remindType?: 0 | 1 | 2;
  57. };
  58. taskInfo?: {
  59. /** 抄送用户列表,工号 */
  60. ccUsers?: string[];
  61. /** 任务截止时间 */
  62. deadlineTime?: {
  63. /** yyyy-MM-dd HH:mm */
  64. format: string;
  65. /** 2015-05-09 08:00 */
  66. value: string;
  67. };
  68. /** 任务提醒时间,单位分钟0:不提醒;15:提前15分钟;60:提前1个小时;180:提前3个小时;1440:提前一天; */
  69. taskRemind?: number;
  70. };
  71. }
  72. /**
  73. * 打开DING、任务、会议界面 返回结果定义
  74. * @apiName biz.ding.create
  75. */
  76. export interface IBizDingCreateResult {
  77. dingCreateResult?: boolean;
  78. }
  79. /**
  80. * 打开DING、任务、会议界面
  81. * @description 钉钉3.5.1版本以后建议使用Ding 2.0发钉接口,Ding 1.0 发钉接口(dd.biz.ding.post)会被慢慢废弃。请大家及时切换,并关注兼容性问题。
  82. * DING 2.0发钉接口支持打开DING、任务、会议界面。
  83. * 目前发钉只支持客户端发钉,不支持直接通过服务端发钉。
  84. * @apiName biz.ding.create
  85. * @supportVersion ios: 3.5.1 android: 3.5.1
  86. */
  87. export declare function create$(params: IBizDingCreateParams): Promise<IBizDingCreateResult>;
  88. export default create$;