@satorijs/adapter-dingtalk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/api/alitrip.d.ts +396 -0
- package/lib/api/attendance.d.ts +62 -0
- package/lib/api/badge.d.ts +232 -0
- package/lib/api/blackboard.d.ts +16 -0
- package/lib/api/calendar.d.ts +620 -0
- package/lib/api/card.d.ts +184 -0
- package/lib/api/conference.d.ts +403 -0
- package/lib/api/connector.d.ts +78 -0
- package/lib/api/contact.d.ts +39 -0
- package/lib/api/convFile.d.ts +134 -0
- package/lib/api/crm.d.ts +661 -0
- package/lib/api/customerService.d.ts +127 -0
- package/lib/api/datacenter.d.ts +505 -0
- package/lib/api/devicemng.d.ts +160 -0
- package/lib/api/diot.d.ts +12 -0
- package/lib/api/doc.d.ts +140 -0
- package/lib/api/drive.d.ts +87 -0
- package/lib/api/edu.d.ts +22 -0
- package/lib/api/esign.d.ts +33 -0
- package/lib/api/exclusive.d.ts +303 -0
- package/lib/api/h3yun.d.ts +437 -0
- package/lib/api/hrm.d.ts +214 -0
- package/lib/api/im.d.ts +772 -0
- package/lib/api/industry.d.ts +117 -0
- package/lib/api/jzcrm.d.ts +254 -0
- package/lib/api/link.d.ts +72 -0
- package/lib/api/live.d.ts +131 -0
- package/lib/api/microApp.d.ts +239 -0
- package/lib/api/oapi.d.ts +3361 -0
- package/lib/api/oauth2.d.ts +114 -0
- package/lib/api/pedia.d.ts +185 -0
- package/lib/api/project.d.ts +1118 -0
- package/lib/api/resident.d.ts +106 -0
- package/lib/api/robot.d.ts +255 -0
- package/lib/api/rooms.d.ts +255 -0
- package/lib/api/serviceGroup.d.ts +175 -0
- package/lib/api/storage.d.ts +1240 -0
- package/lib/api/swform.d.ts +70 -0
- package/lib/api/todo.d.ts +168 -0
- package/lib/api/wiki.d.ts +194 -0
- package/lib/api/workbench.d.ts +45 -0
- package/lib/api/yida.d.ts +1837 -0
- package/lib/bot.d.ts +30 -0
- package/lib/http.d.ts +7 -0
- package/lib/index.d.ts +7 -0
- package/lib/index.js +1814 -0
- package/lib/index.js.map +7 -0
- package/lib/internal.d.ts +7 -0
- package/lib/message.d.ts +17 -0
- package/lib/types/index.d.ts +133 -0
- package/lib/utils.d.ts +4 -0
- package/lib/ws.d.ts +12 -0
- package/package.json +31 -0
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
export interface UpdateCardParams {
|
|
2
|
+
/** 外部卡片实例Id。 */
|
|
3
|
+
outTrackId: string;
|
|
4
|
+
/** 卡片数据 */
|
|
5
|
+
cardData?: unknown;
|
|
6
|
+
/** 用户的私有数据。 */
|
|
7
|
+
privateData?: unknown;
|
|
8
|
+
/** 卡片更新选项 */
|
|
9
|
+
cardUpdateOptions?: unknown;
|
|
10
|
+
}
|
|
11
|
+
export interface UpdateCardResponse {
|
|
12
|
+
success?: unknown;
|
|
13
|
+
result?: unknown;
|
|
14
|
+
}
|
|
15
|
+
export interface CreateCardParams {
|
|
16
|
+
/** 卡片创建者的userId。 */
|
|
17
|
+
userId?: string;
|
|
18
|
+
/** 卡片内容模板ID,可通过登录[开发者后台 > 卡片平台](https://open-dev.dingtalk.com/fe/card)获取。 */
|
|
19
|
+
cardTemplateId: string;
|
|
20
|
+
/** 外部卡片实例Id。 */
|
|
21
|
+
outTrackId: string;
|
|
22
|
+
/** 卡片回调的类型: */
|
|
23
|
+
callbackType?: string;
|
|
24
|
+
/** 卡片回调HTTP模式时的路由 Key,用于查询注册的 callbackUrl。 */
|
|
25
|
+
callbackRouteKey?: string;
|
|
26
|
+
/** 卡片数据,示例: */
|
|
27
|
+
cardData: unknown;
|
|
28
|
+
/** 用户的私有数据: */
|
|
29
|
+
privateData?: unknown;
|
|
30
|
+
/** 动态数据源配置。 */
|
|
31
|
+
openDynamicDataConfig?: unknown;
|
|
32
|
+
/** IM 群聊场域信息。 */
|
|
33
|
+
imGroupOpenSpaceModel?: unknown;
|
|
34
|
+
/** IM 单聊场域信息。 */
|
|
35
|
+
imRobotOpenSpaceModel?: unknown;
|
|
36
|
+
/** 协作场域信息。 */
|
|
37
|
+
coFeedOpenSpaceModel?: unknown;
|
|
38
|
+
/** 吊顶场域信息。 */
|
|
39
|
+
topOpenSpaceModel?: unknown;
|
|
40
|
+
/** 用户id类型: */
|
|
41
|
+
userIdType?: number;
|
|
42
|
+
}
|
|
43
|
+
export interface CreateCardResponse {
|
|
44
|
+
success?: unknown;
|
|
45
|
+
result?: string;
|
|
46
|
+
}
|
|
47
|
+
export interface CreateAndDeliverParams {
|
|
48
|
+
/** 卡片创建者的userId。 */
|
|
49
|
+
userId?: string;
|
|
50
|
+
/** 卡片内容模板ID,可通过登录[开发者后台 > 卡片平台](https://open-dev.dingtalk.com/fe/card)获取。 */
|
|
51
|
+
cardTemplateId: string;
|
|
52
|
+
/** 外部卡片实例Id。 */
|
|
53
|
+
outTrackId: string;
|
|
54
|
+
/** 卡片回调的类型: */
|
|
55
|
+
callbackType?: string;
|
|
56
|
+
/** 卡片回调HTTP模式时的路由 Key,用于查询注册的 callbackUrl。 */
|
|
57
|
+
callbackRouteKey?: string;
|
|
58
|
+
/** 卡片数据,示例: */
|
|
59
|
+
cardData: unknown;
|
|
60
|
+
/** 用户的私有数据: */
|
|
61
|
+
privateData?: unknown;
|
|
62
|
+
/** 动态数据源配置。 */
|
|
63
|
+
openDynamicDataConfig?: unknown;
|
|
64
|
+
/** IM群聊场域信息。 */
|
|
65
|
+
imGroupOpenSpaceModel?: unknown;
|
|
66
|
+
/** IM机器人单聊场域信息。 */
|
|
67
|
+
imRobotOpenSpaceModel?: unknown;
|
|
68
|
+
/** 协作场域信息。 */
|
|
69
|
+
coFeedOpenSpaceModel?: unknown;
|
|
70
|
+
/** 吊顶场域信息。 */
|
|
71
|
+
topOpenSpaceModel?: unknown;
|
|
72
|
+
/** 表示场域及其场域id,其格式为`dtv1.card//spaceType1.spaceId1;spaceType2.spaceId2_1;spaceType2.spaceId2_2;spaceType3.spaceId3`。 */
|
|
73
|
+
openSpaceId: string;
|
|
74
|
+
/** 群聊投放参数。 */
|
|
75
|
+
imGroupOpenDeliverModel?: unknown;
|
|
76
|
+
/** IM机器人单聊投放参数。 */
|
|
77
|
+
imRobotOpenDeliverModel?: unknown;
|
|
78
|
+
/** 吊顶投放参数。 */
|
|
79
|
+
topOpenDeliverModel?: unknown;
|
|
80
|
+
/** 协作投放参数。 */
|
|
81
|
+
coFeedOpenDeliverModel?: unknown;
|
|
82
|
+
/** 文档投放参数 */
|
|
83
|
+
docOpenDeliverModel?: unknown;
|
|
84
|
+
/** 用户userId类型: */
|
|
85
|
+
userIdType?: number;
|
|
86
|
+
}
|
|
87
|
+
export interface CreateAndDeliverResponse {
|
|
88
|
+
success?: unknown;
|
|
89
|
+
result?: {
|
|
90
|
+
outTrackId?: string;
|
|
91
|
+
deliverResults?: number;
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
export interface RegisterCallbackParams {
|
|
95
|
+
/** 回调地址的路由 Key,一个 callbackRouteKey 仅可映射一个 callbackUrl */
|
|
96
|
+
callbackRouteKey: string;
|
|
97
|
+
/** 接受动态卡片回调的 URL 地址 */
|
|
98
|
+
callbackUrl: string;
|
|
99
|
+
/** 加密密钥用于校验来源 */
|
|
100
|
+
apiSecret?: string;
|
|
101
|
+
/** 是否强制覆盖更新,默认 false。 */
|
|
102
|
+
forceUpdate?: unknown;
|
|
103
|
+
}
|
|
104
|
+
export interface RegisterCallbackResponse {
|
|
105
|
+
success?: unknown;
|
|
106
|
+
result?: {
|
|
107
|
+
callbackUrl?: string;
|
|
108
|
+
apiSecret?: string;
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
export interface AppendSpaceParams {
|
|
112
|
+
/** 外部卡片实例Id。 */
|
|
113
|
+
outTrackId: string;
|
|
114
|
+
/** IM群聊场域信息 */
|
|
115
|
+
imGroupOpenSpaceModel?: unknown;
|
|
116
|
+
/** 机器人单聊场域参数 */
|
|
117
|
+
imRobotOpenSpaceModel?: unknown;
|
|
118
|
+
/** 吊顶场域信息 */
|
|
119
|
+
topOpenSpaceModel?: unknown;
|
|
120
|
+
/** 协作场域信息 */
|
|
121
|
+
coFeedOpenSpaceModel?: unknown;
|
|
122
|
+
}
|
|
123
|
+
export interface AppendSpaceResponse {
|
|
124
|
+
success?: unknown;
|
|
125
|
+
result?: unknown;
|
|
126
|
+
}
|
|
127
|
+
export interface DeliverCardParams {
|
|
128
|
+
/** 外部卡片实例Id。 */
|
|
129
|
+
outTrackId: string;
|
|
130
|
+
/** 表示场域及其场域id,其格式为dtv1.card//spaceType1.spaceId1;spaceType2,spaceId2;spaceType3,spaceId3 */
|
|
131
|
+
openSpaceId: string;
|
|
132
|
+
/** 单聊场域投放参数 */
|
|
133
|
+
imSingleOpenDeliverModel?: unknown;
|
|
134
|
+
/** 群聊投放参数 */
|
|
135
|
+
imGroupOpenDeliverModel?: unknown;
|
|
136
|
+
/** 吊顶投放参数 */
|
|
137
|
+
topOpenDeliverModel?: unknown;
|
|
138
|
+
/** 协作投放参数 */
|
|
139
|
+
coFeedOpenDeliverModel?: unknown;
|
|
140
|
+
/** 工作台投放参数 */
|
|
141
|
+
workBenchOpenDeliverModel?: unknown;
|
|
142
|
+
}
|
|
143
|
+
export interface DeliverCardResponse {
|
|
144
|
+
success?: unknown;
|
|
145
|
+
result?: {
|
|
146
|
+
spaceType?: string;
|
|
147
|
+
spaceId?: string;
|
|
148
|
+
success?: number;
|
|
149
|
+
}[];
|
|
150
|
+
}
|
|
151
|
+
declare module '../internal' {
|
|
152
|
+
interface Internal {
|
|
153
|
+
/**
|
|
154
|
+
* 更新卡片
|
|
155
|
+
* @see https://developers.dingtalk.com/document/orgapp/interactive-card-update-interface
|
|
156
|
+
*/
|
|
157
|
+
updateCard(params: UpdateCardParams): Promise<UpdateCardResponse>;
|
|
158
|
+
/**
|
|
159
|
+
* 创建卡片
|
|
160
|
+
* @see https://developers.dingtalk.com/document/orgapp/interface-for-creating-a-card-instance
|
|
161
|
+
*/
|
|
162
|
+
createCard(params: CreateCardParams): Promise<CreateCardResponse>;
|
|
163
|
+
/**
|
|
164
|
+
* 创建并投放卡片
|
|
165
|
+
* @see https://developers.dingtalk.com/document/orgapp/create-and-deliver-cards
|
|
166
|
+
*/
|
|
167
|
+
createAndDeliver(params: CreateAndDeliverParams): Promise<CreateAndDeliverResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* 注册卡片回调地址
|
|
170
|
+
* @see https://developers.dingtalk.com/document/orgapp/register-card-callback-address
|
|
171
|
+
*/
|
|
172
|
+
registerCallback(params: RegisterCallbackParams): Promise<RegisterCallbackResponse>;
|
|
173
|
+
/**
|
|
174
|
+
* 新增或更新卡片的场域信息
|
|
175
|
+
* @see https://developers.dingtalk.com/document/orgapp/add-field-interface
|
|
176
|
+
*/
|
|
177
|
+
appendSpace(params: AppendSpaceParams): Promise<AppendSpaceResponse>;
|
|
178
|
+
/**
|
|
179
|
+
* 投放卡片
|
|
180
|
+
* @see https://developers.dingtalk.com/document/isvapp/delivery-card-interface
|
|
181
|
+
*/
|
|
182
|
+
deliverCard(params: DeliverCardParams): Promise<DeliverCardResponse>;
|
|
183
|
+
}
|
|
184
|
+
}
|
|
@@ -0,0 +1,403 @@
|
|
|
1
|
+
export interface InviteUsersParams {
|
|
2
|
+
/** 操作用户unionId。 */
|
|
3
|
+
unionId?: string;
|
|
4
|
+
/** 被邀请人对象。 */
|
|
5
|
+
inviteeList?: object[];
|
|
6
|
+
}
|
|
7
|
+
export interface InviteUsersResponse {
|
|
8
|
+
success?: unknown;
|
|
9
|
+
}
|
|
10
|
+
export interface FocusParams {
|
|
11
|
+
/** 行为动作: */
|
|
12
|
+
action: string;
|
|
13
|
+
/** 被操作用户unionId。 */
|
|
14
|
+
unionId: string;
|
|
15
|
+
}
|
|
16
|
+
export interface FocusResponse {
|
|
17
|
+
success?: unknown;
|
|
18
|
+
}
|
|
19
|
+
export interface CohostsParams {
|
|
20
|
+
/** 行为动作: */
|
|
21
|
+
action: string;
|
|
22
|
+
/** 被操作用户对象。 */
|
|
23
|
+
userList: object[];
|
|
24
|
+
}
|
|
25
|
+
export interface CohostsResponse {
|
|
26
|
+
success?: unknown;
|
|
27
|
+
}
|
|
28
|
+
export interface MuteMembersParams {
|
|
29
|
+
/** 操作类型: */
|
|
30
|
+
action: string;
|
|
31
|
+
/** 被操作用户对象。 */
|
|
32
|
+
userList: object[];
|
|
33
|
+
}
|
|
34
|
+
export interface MuteMembersResponse {
|
|
35
|
+
success?: unknown;
|
|
36
|
+
}
|
|
37
|
+
export interface QueryScheduleConferenceInfoQuery {
|
|
38
|
+
/** 标记当前开始读取的位置,置空表示从头开始 */
|
|
39
|
+
nextToken?: string;
|
|
40
|
+
/** 本次读取的最大数据记录数量 */
|
|
41
|
+
maxResults?: number;
|
|
42
|
+
}
|
|
43
|
+
export interface QueryScheduleConferenceInfoResponse {
|
|
44
|
+
totalCount?: number;
|
|
45
|
+
nextToken: string;
|
|
46
|
+
conferenceList?: {
|
|
47
|
+
conferenceId?: string;
|
|
48
|
+
title?: string;
|
|
49
|
+
roomCode?: string;
|
|
50
|
+
status?: number;
|
|
51
|
+
startTime?: number;
|
|
52
|
+
endTime?: number;
|
|
53
|
+
}[];
|
|
54
|
+
}
|
|
55
|
+
export interface QueryCloudRecordVideoQuery {
|
|
56
|
+
/** 用户unionId。 */
|
|
57
|
+
unionId: string;
|
|
58
|
+
}
|
|
59
|
+
export interface QueryCloudRecordVideoResponse {
|
|
60
|
+
videoList?: {
|
|
61
|
+
recordId?: string;
|
|
62
|
+
unionId?: string;
|
|
63
|
+
startTime?: number;
|
|
64
|
+
recordType?: number;
|
|
65
|
+
duration?: number;
|
|
66
|
+
fileSize?: number;
|
|
67
|
+
endTime?: number;
|
|
68
|
+
mediaId?: string;
|
|
69
|
+
regionId?: string;
|
|
70
|
+
}[];
|
|
71
|
+
}
|
|
72
|
+
export interface QueryCloudRecordTextQuery {
|
|
73
|
+
/** 用户unionId。 */
|
|
74
|
+
unionId?: string;
|
|
75
|
+
/** 开始时间的千分之一秒,单位毫秒。 */
|
|
76
|
+
startTime?: number;
|
|
77
|
+
/** 查询方式: */
|
|
78
|
+
direction?: string;
|
|
79
|
+
/** 单词查询条数,最大2000。 */
|
|
80
|
+
maxResults?: number;
|
|
81
|
+
/** 分页游标。 */
|
|
82
|
+
nextToken?: number;
|
|
83
|
+
}
|
|
84
|
+
export interface QueryCloudRecordTextResponse {
|
|
85
|
+
hasMore?: unknown;
|
|
86
|
+
paragraphList?: {
|
|
87
|
+
nextTtoken?: number;
|
|
88
|
+
status?: number;
|
|
89
|
+
unionId?: string;
|
|
90
|
+
nickName?: string;
|
|
91
|
+
recordId?: number;
|
|
92
|
+
startTime?: number;
|
|
93
|
+
endTime?: number;
|
|
94
|
+
paragraph?: string;
|
|
95
|
+
sentenceList?: number;
|
|
96
|
+
}[];
|
|
97
|
+
}
|
|
98
|
+
export interface QueryCloudRecordVideoPlayInfoQuery {
|
|
99
|
+
/** 用户unionId。 */
|
|
100
|
+
unionId: string;
|
|
101
|
+
/** 媒体文件ID。 */
|
|
102
|
+
mediaId: string;
|
|
103
|
+
/** 地域ID。 */
|
|
104
|
+
regionId: string;
|
|
105
|
+
}
|
|
106
|
+
export interface QueryCloudRecordVideoPlayInfoResponse {
|
|
107
|
+
playUrl?: string;
|
|
108
|
+
mp4FileUrl?: string;
|
|
109
|
+
fileSize?: number;
|
|
110
|
+
duration?: number;
|
|
111
|
+
status?: number;
|
|
112
|
+
}
|
|
113
|
+
export interface StopCloudRecordParams {
|
|
114
|
+
/** 用户unionId。 */
|
|
115
|
+
unionId: string;
|
|
116
|
+
}
|
|
117
|
+
export interface StopCloudRecordResponse {
|
|
118
|
+
code?: string;
|
|
119
|
+
}
|
|
120
|
+
export interface StopStreamOutParams {
|
|
121
|
+
/** 推流ID,开启视频会议直播推流后生成。 */
|
|
122
|
+
streamId: string;
|
|
123
|
+
/** 是否停止所有流,为true时**streamId**参数无效。 */
|
|
124
|
+
stopAllStream: unknown;
|
|
125
|
+
/** 用户unionId,可以调用[通过免登码获取用户信息(v2)](https://developers.dingtalk.com/document/app/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取。 */
|
|
126
|
+
unionId: string;
|
|
127
|
+
}
|
|
128
|
+
export interface StopStreamOutResponse {
|
|
129
|
+
code: string;
|
|
130
|
+
}
|
|
131
|
+
export interface StartStreamOutParams {
|
|
132
|
+
/** 用户unionId,可以调用[通过免登码获取用户信息(v2)](https://developers.dingtalk.com/document/app/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取。 */
|
|
133
|
+
unionId: string;
|
|
134
|
+
/** 是否需要主持人加入后才允许推流。 */
|
|
135
|
+
needHostJoin: unknown;
|
|
136
|
+
/** 推流地址列表,最多10个,需要以rtmp开头。 */
|
|
137
|
+
streamUrlList: string[];
|
|
138
|
+
/** 推流名称。 */
|
|
139
|
+
streamName: string;
|
|
140
|
+
/** 布局,取值: */
|
|
141
|
+
mode: string;
|
|
142
|
+
/** 小窗位置,取值: */
|
|
143
|
+
smallWindowPosition: string;
|
|
144
|
+
}
|
|
145
|
+
export interface StartStreamOutResponse {
|
|
146
|
+
successStreamMap?: unknown;
|
|
147
|
+
failStreamMap?: unknown;
|
|
148
|
+
}
|
|
149
|
+
export interface StartCloudRecordParams {
|
|
150
|
+
/** 用户unionId。 */
|
|
151
|
+
unionId: string;
|
|
152
|
+
/** 小窗位置,取值: */
|
|
153
|
+
smallWindowPosition?: string;
|
|
154
|
+
/** 布局,取值: */
|
|
155
|
+
mode?: string;
|
|
156
|
+
}
|
|
157
|
+
export interface StartCloudRecordResponse {
|
|
158
|
+
code?: string;
|
|
159
|
+
}
|
|
160
|
+
export interface QueryConferenceInfoBatchParams {
|
|
161
|
+
/** 会议ID列表。 */
|
|
162
|
+
conferenceIdList: string[];
|
|
163
|
+
}
|
|
164
|
+
export interface QueryConferenceInfoBatchResponse {
|
|
165
|
+
infos?: {
|
|
166
|
+
conferenceId?: string;
|
|
167
|
+
title?: string;
|
|
168
|
+
startTime?: number;
|
|
169
|
+
status?: number;
|
|
170
|
+
mediaStatus?: number;
|
|
171
|
+
userList?: number;
|
|
172
|
+
}[];
|
|
173
|
+
}
|
|
174
|
+
export interface CloseVideoConferenceQuery {
|
|
175
|
+
/** 员工在当前开发者企业账号范围内的唯一标识。 */
|
|
176
|
+
unionId: string;
|
|
177
|
+
}
|
|
178
|
+
export interface CloseVideoConferenceResponse {
|
|
179
|
+
code: number;
|
|
180
|
+
cause?: string;
|
|
181
|
+
}
|
|
182
|
+
export interface CreateVideoConferenceParams {
|
|
183
|
+
/** 会议发起人的unionId。 */
|
|
184
|
+
userId: string;
|
|
185
|
+
/** 会议主题,最多不能超20个中文。 */
|
|
186
|
+
confTitle: string;
|
|
187
|
+
/** 邀请参会人员unionId列表。 */
|
|
188
|
+
inviteUserIds?: string[];
|
|
189
|
+
/** 是否邀请主叫。 */
|
|
190
|
+
inviteCaller?: unknown;
|
|
191
|
+
}
|
|
192
|
+
export interface CreateVideoConferenceResponse {
|
|
193
|
+
conferenceId: string;
|
|
194
|
+
conferencePassword?: string;
|
|
195
|
+
hostPassword?: string;
|
|
196
|
+
externalLinkUrl?: string;
|
|
197
|
+
phoneNumbers?: string[];
|
|
198
|
+
roomCode?: string;
|
|
199
|
+
}
|
|
200
|
+
export interface QueryConferenceMembersQuery {
|
|
201
|
+
/** 分页游标。 */
|
|
202
|
+
nextToken?: string;
|
|
203
|
+
/** 每页最大条目数,默认值300,无最大值限制。 */
|
|
204
|
+
maxResults?: number;
|
|
205
|
+
}
|
|
206
|
+
export interface QueryConferenceMembersResponse {
|
|
207
|
+
memberModels?: {
|
|
208
|
+
unionId?: string;
|
|
209
|
+
conferenceId?: string;
|
|
210
|
+
userNick?: string;
|
|
211
|
+
joinTime?: number;
|
|
212
|
+
leaveTime?: number;
|
|
213
|
+
duration?: number;
|
|
214
|
+
host?: number;
|
|
215
|
+
attendStatus?: number;
|
|
216
|
+
outerOrgMember?: number;
|
|
217
|
+
pstnJoin?: number;
|
|
218
|
+
coHost?: number;
|
|
219
|
+
}[];
|
|
220
|
+
nextToken?: string;
|
|
221
|
+
totalCount?: number;
|
|
222
|
+
}
|
|
223
|
+
export interface QueryConferenceInfoResponse {
|
|
224
|
+
confInfo?: {
|
|
225
|
+
activeNum?: number;
|
|
226
|
+
attendNum?: number;
|
|
227
|
+
confDuration?: number;
|
|
228
|
+
conferenceId?: string;
|
|
229
|
+
creatorId?: string;
|
|
230
|
+
creatorNick?: string;
|
|
231
|
+
externalLinkUrl?: string;
|
|
232
|
+
invitedNum?: number;
|
|
233
|
+
startTime?: number;
|
|
234
|
+
status?: number;
|
|
235
|
+
title?: string;
|
|
236
|
+
roomCode?: string;
|
|
237
|
+
endTime?: number;
|
|
238
|
+
};
|
|
239
|
+
}
|
|
240
|
+
export interface CancelScheduleConferenceParams {
|
|
241
|
+
/** 预约会议id: */
|
|
242
|
+
scheduleConferenceId: string;
|
|
243
|
+
/** 预约会议创建者unionId。 */
|
|
244
|
+
creatorUnionId: string;
|
|
245
|
+
}
|
|
246
|
+
export interface CancelScheduleConferenceResponse {
|
|
247
|
+
success?: unknown;
|
|
248
|
+
}
|
|
249
|
+
export interface QueryScheduleConferenceQuery {
|
|
250
|
+
/** 请求者unionId。 */
|
|
251
|
+
requestUnionId: string;
|
|
252
|
+
}
|
|
253
|
+
export interface QueryScheduleConferenceResponse {
|
|
254
|
+
requestId?: string;
|
|
255
|
+
scheduleConferenceId?: string;
|
|
256
|
+
title?: string;
|
|
257
|
+
startTime?: number;
|
|
258
|
+
endTime?: number;
|
|
259
|
+
roomCode?: string;
|
|
260
|
+
url?: string;
|
|
261
|
+
phones?: string[];
|
|
262
|
+
}
|
|
263
|
+
export interface UpdateScheduleConferenceParams {
|
|
264
|
+
/** 预约会议创建者unionId。 */
|
|
265
|
+
creatorUnionId: string;
|
|
266
|
+
/** 预约会议id: */
|
|
267
|
+
scheduleConferenceId: string;
|
|
268
|
+
/** 预约会议标题。 */
|
|
269
|
+
title: string;
|
|
270
|
+
/** 预约会议开始时间,毫秒级UTC时间戳。 */
|
|
271
|
+
startTime: number;
|
|
272
|
+
/** 预约会议结束时间,毫秒级UTC时间戳。 */
|
|
273
|
+
endTime: number;
|
|
274
|
+
}
|
|
275
|
+
export interface UpdateScheduleConferenceResponse {
|
|
276
|
+
success?: unknown;
|
|
277
|
+
}
|
|
278
|
+
export interface CreateScheduleConferenceParams {
|
|
279
|
+
/** 创建者unionId。 */
|
|
280
|
+
creatorUnionId: string;
|
|
281
|
+
/** 预约会议标题。 */
|
|
282
|
+
title: string;
|
|
283
|
+
/** 预约会议开始时间,毫秒级UTC时间戳。 */
|
|
284
|
+
startTime: number;
|
|
285
|
+
/** 预约会议结束时间,毫秒级UTC时间戳。 */
|
|
286
|
+
endTime: number;
|
|
287
|
+
}
|
|
288
|
+
export interface CreateScheduleConferenceResponse {
|
|
289
|
+
requestId?: string;
|
|
290
|
+
scheduleConferenceId?: string;
|
|
291
|
+
roomCode?: string;
|
|
292
|
+
url?: string;
|
|
293
|
+
phones?: string[];
|
|
294
|
+
}
|
|
295
|
+
declare module '../internal' {
|
|
296
|
+
interface Internal {
|
|
297
|
+
/**
|
|
298
|
+
* 邀请其他人员
|
|
299
|
+
* @see https://developers.dingtalk.com/document/orgapp/invite-users-to-join
|
|
300
|
+
*/
|
|
301
|
+
inviteUsers(conferenceId: string, params: InviteUsersParams): Promise<InviteUsersResponse>;
|
|
302
|
+
/**
|
|
303
|
+
* 设置全员看他
|
|
304
|
+
* @see https://developers.dingtalk.com/document/orgapp/set-the-whole-staff-to-see-him
|
|
305
|
+
*/
|
|
306
|
+
focus(conferenceId: string, params: FocusParams): Promise<FocusResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* 设置联席主持人
|
|
309
|
+
* @see https://developers.dingtalk.com/document/orgapp/set-up-co-hosts
|
|
310
|
+
*/
|
|
311
|
+
cohosts(conferenceId: string, params: CohostsParams): Promise<CohostsResponse>;
|
|
312
|
+
/**
|
|
313
|
+
* 指定人员静音或取消静音
|
|
314
|
+
* @see https://developers.dingtalk.com/document/orgapp/specify-person-to-mute-or-unmute
|
|
315
|
+
*/
|
|
316
|
+
muteMembers(conferenceId: string, params: MuteMembersParams): Promise<MuteMembersResponse>;
|
|
317
|
+
/**
|
|
318
|
+
* 分页获取预约会议历史会议信息,当前仅返回最后一次的会议信息
|
|
319
|
+
* @see https://developers.dingtalk.com/document/orgapp/query-appointment-meeting-history-meeting-information
|
|
320
|
+
*/
|
|
321
|
+
queryScheduleConferenceInfo(scheduleConferenceId: string, query: QueryScheduleConferenceInfoQuery): Promise<QueryScheduleConferenceInfoResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* 查询会议录制的详情信息
|
|
324
|
+
* @see https://developers.dingtalk.com/document/isvapp/query-recording-information
|
|
325
|
+
*/
|
|
326
|
+
queryCloudRecordVideo(conferenceId: string, query: QueryCloudRecordVideoQuery): Promise<QueryCloudRecordVideoResponse>;
|
|
327
|
+
/**
|
|
328
|
+
* 查询会议录制中的文本信息
|
|
329
|
+
* @see https://developers.dingtalk.com/document/isvapp/queries-the-text-information-about-cloud-recording
|
|
330
|
+
*/
|
|
331
|
+
queryCloudRecordText(conferenceId: string, query: QueryCloudRecordTextQuery): Promise<QueryCloudRecordTextResponse>;
|
|
332
|
+
/**
|
|
333
|
+
* 查询会议录制中的视频信息
|
|
334
|
+
* @see https://developers.dingtalk.com/document/isvapp/queries-the-playback-information-about-a-recorded-cloud-video
|
|
335
|
+
*/
|
|
336
|
+
queryCloudRecordVideoPlayInfo(conferenceId: string, query: QueryCloudRecordVideoPlayInfoQuery): Promise<QueryCloudRecordVideoPlayInfoResponse>;
|
|
337
|
+
/**
|
|
338
|
+
* 停止视频会议云录制
|
|
339
|
+
* @see https://developers.dingtalk.com/document/isvapp/video-conferencing-stops-cloud-recording
|
|
340
|
+
*/
|
|
341
|
+
stopCloudRecord(conferenceId: string, params: StopCloudRecordParams): Promise<StopCloudRecordResponse>;
|
|
342
|
+
/**
|
|
343
|
+
* 会议停止直播推流
|
|
344
|
+
* @see https://developers.dingtalk.com/document/orgapp/videoconferencing-stops-live-stream-ingest
|
|
345
|
+
*/
|
|
346
|
+
stopStreamOut(conferenceId: string, params: StopStreamOutParams): Promise<StopStreamOutResponse>;
|
|
347
|
+
/**
|
|
348
|
+
* 会议开始直播推流
|
|
349
|
+
* @see https://developers.dingtalk.com/document/orgapp/video-conference-enables-live-stream-ingest
|
|
350
|
+
*/
|
|
351
|
+
startStreamOut(conferenceId: string, params: StartStreamOutParams): Promise<StartStreamOutResponse>;
|
|
352
|
+
/**
|
|
353
|
+
* 开启视频会议云录制
|
|
354
|
+
* @see https://developers.dingtalk.com/document/isvapp/video-conference-open-cloud-recording
|
|
355
|
+
*/
|
|
356
|
+
startCloudRecord(conferenceId: string, params: StartCloudRecordParams): Promise<StartCloudRecordResponse>;
|
|
357
|
+
/**
|
|
358
|
+
* 批量查询视频会议信息
|
|
359
|
+
* @see https://developers.dingtalk.com/document/isvapp/batch-query-of-video-conference-information
|
|
360
|
+
*/
|
|
361
|
+
queryConferenceInfoBatch(params: QueryConferenceInfoBatchParams): Promise<QueryConferenceInfoBatchResponse>;
|
|
362
|
+
/**
|
|
363
|
+
* 关闭视频会议
|
|
364
|
+
* @see https://developers.dingtalk.com/document/isvapp/close-audio-video-conferencing
|
|
365
|
+
*/
|
|
366
|
+
closeVideoConference(conferenceId: string, query: CloseVideoConferenceQuery): Promise<CloseVideoConferenceResponse>;
|
|
367
|
+
/**
|
|
368
|
+
* 创建视频会议
|
|
369
|
+
* @see https://developers.dingtalk.com/document/isvapp/create-a-video-conference
|
|
370
|
+
*/
|
|
371
|
+
createVideoConference(params: CreateVideoConferenceParams): Promise<CreateVideoConferenceResponse>;
|
|
372
|
+
/**
|
|
373
|
+
* 查询视频会议成员
|
|
374
|
+
* @see https://developers.dingtalk.com/document/app/query-video-meeting-member-information
|
|
375
|
+
*/
|
|
376
|
+
queryConferenceMembers(conferenceId: string, query: QueryConferenceMembersQuery): Promise<QueryConferenceMembersResponse>;
|
|
377
|
+
/**
|
|
378
|
+
* 查询视频会议信息
|
|
379
|
+
* @see https://developers.dingtalk.com/document/app/querying-video-conference-information
|
|
380
|
+
*/
|
|
381
|
+
queryConferenceInfo(conferenceId: string): Promise<QueryConferenceInfoResponse>;
|
|
382
|
+
/**
|
|
383
|
+
* 取消预约会议
|
|
384
|
+
* @see https://developers.dingtalk.com/document/app/cancel-appointment-meeting
|
|
385
|
+
*/
|
|
386
|
+
cancelScheduleConference(params: CancelScheduleConferenceParams): Promise<CancelScheduleConferenceResponse>;
|
|
387
|
+
/**
|
|
388
|
+
* 查询预约会议信息
|
|
389
|
+
* @see https://developers.dingtalk.com/document/app/query-meeting-reservation
|
|
390
|
+
*/
|
|
391
|
+
queryScheduleConference(scheduleConferenceId: string, query: QueryScheduleConferenceQuery): Promise<QueryScheduleConferenceResponse>;
|
|
392
|
+
/**
|
|
393
|
+
* 更新预约会议
|
|
394
|
+
* @see https://developers.dingtalk.com/document/app/update-appointment-meeting
|
|
395
|
+
*/
|
|
396
|
+
updateScheduleConference(params: UpdateScheduleConferenceParams): Promise<UpdateScheduleConferenceResponse>;
|
|
397
|
+
/**
|
|
398
|
+
* 创建预约会议
|
|
399
|
+
* @see https://developers.dingtalk.com/document/app/create-appointment-meeting
|
|
400
|
+
*/
|
|
401
|
+
createScheduleConference(params: CreateScheduleConferenceParams): Promise<CreateScheduleConferenceResponse>;
|
|
402
|
+
}
|
|
403
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
export interface PullDataByPkQuery {
|
|
2
|
+
/** 数据的主键字段值。 */
|
|
3
|
+
primaryKey: string;
|
|
4
|
+
/** 同步数据的应用ID,第三方企业应用传应用的appId,企业自建应用传agentId。 */
|
|
5
|
+
appId?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface PullDataByPkResponse {
|
|
8
|
+
dataGmtCreate: number;
|
|
9
|
+
dataGmtModified: number;
|
|
10
|
+
dataCreateAppType: string;
|
|
11
|
+
dataCreateAppId: string;
|
|
12
|
+
dataModifiedAppType: string;
|
|
13
|
+
dataModifiedAppId: string;
|
|
14
|
+
jsonData: string;
|
|
15
|
+
}
|
|
16
|
+
export interface PullDataByPageQuery {
|
|
17
|
+
/** 要拉取的主数据模型id。 */
|
|
18
|
+
dataModelId: string;
|
|
19
|
+
/** 用于过滤时间范围的字段,包含数据创建时间(dataGmtCreate)和数据修改时间(dataGmtModified),如不传则不过滤。 */
|
|
20
|
+
datetimeFilterField?: string;
|
|
21
|
+
/** 当配置了datetimeFilterField字段后,数据的时间起点,如果不传则将最早一条数据作为起点。 */
|
|
22
|
+
minDatetime?: number;
|
|
23
|
+
/** 当配置了datetimeFilterField字段后,数据的时间终点,如果不传则按最新一条数据作为终点。 */
|
|
24
|
+
maxDatetime?: number;
|
|
25
|
+
/** 用于翻页的游标,如果为空则从第一条数据开始查询。 */
|
|
26
|
+
nextToken?: string;
|
|
27
|
+
/** 单次获取的最大记录条数,最大限制100条。 */
|
|
28
|
+
maxResults?: number;
|
|
29
|
+
/** 同步数据的应用ID,第三方企业应用传应用的appId,企业自建应用传agentId。 */
|
|
30
|
+
appId?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface PullDataByPageResponse {
|
|
33
|
+
list: {
|
|
34
|
+
dataGmtCreate: number;
|
|
35
|
+
dataGmtModified: number;
|
|
36
|
+
dataCreateAppType: string;
|
|
37
|
+
dataCreateAppId: string;
|
|
38
|
+
dataModifiedAppType: string;
|
|
39
|
+
dataModifiedAppId: string;
|
|
40
|
+
jsonData: string;
|
|
41
|
+
}[];
|
|
42
|
+
nextToken?: string;
|
|
43
|
+
maxResults?: number;
|
|
44
|
+
}
|
|
45
|
+
export interface SyncDataParams {
|
|
46
|
+
/** 支持批量同步数据。 */
|
|
47
|
+
triggerDataList: object[];
|
|
48
|
+
/** 同步数据的应用ID: */
|
|
49
|
+
appId?: string;
|
|
50
|
+
}
|
|
51
|
+
export interface SyncDataResponse {
|
|
52
|
+
list: {
|
|
53
|
+
triggerId: string;
|
|
54
|
+
bizPrimaryKey: string;
|
|
55
|
+
success: number;
|
|
56
|
+
subErrCode: string;
|
|
57
|
+
subErrMsg: string;
|
|
58
|
+
}[];
|
|
59
|
+
}
|
|
60
|
+
declare module '../internal' {
|
|
61
|
+
interface Internal {
|
|
62
|
+
/**
|
|
63
|
+
* 通过业务主键拉取单条连接器主数据
|
|
64
|
+
* @see https://developers.dingtalk.com/document/connector/pull-a-single-primary-record-based-on-the-business-primary
|
|
65
|
+
*/
|
|
66
|
+
pullDataByPk(dataModelId: string, query: PullDataByPkQuery): Promise<PullDataByPkResponse>;
|
|
67
|
+
/**
|
|
68
|
+
* 分页拉取连接器主数据
|
|
69
|
+
* @see https://developers.dingtalk.com/document/connector/bulk-pull-dingtalk-connector-master-data
|
|
70
|
+
*/
|
|
71
|
+
pullDataByPage(query: PullDataByPageQuery): Promise<PullDataByPageResponse>;
|
|
72
|
+
/**
|
|
73
|
+
* 同步连接器数据
|
|
74
|
+
* @see https://developers.dingtalk.com/document/connector/dingtalk-connector-data-synchronization-interface
|
|
75
|
+
*/
|
|
76
|
+
syncData(params: SyncDataParams): Promise<SyncDataResponse>;
|
|
77
|
+
}
|
|
78
|
+
}
|