@koreaaitel/sdk 0.0.0-stage → 0.62.1
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/LICENSE +21 -0
- package/README.md +943 -2
- package/dist/agent/index.cjs +5512 -0
- package/dist/agent/index.cjs.map +1 -0
- package/dist/agent/index.d.cts +1574 -0
- package/dist/agent/index.d.ts +1574 -0
- package/dist/agent/index.js +5402 -0
- package/dist/agent/index.js.map +1 -0
- package/dist/agent/livekit/index.cjs +675 -0
- package/dist/agent/livekit/index.cjs.map +1 -0
- package/dist/agent/livekit/index.d.cts +165 -0
- package/dist/agent/livekit/index.d.ts +165 -0
- package/dist/agent/livekit/index.js +669 -0
- package/dist/agent/livekit/index.js.map +1 -0
- package/dist/chunk-35XJNMFU.js +10 -0
- package/dist/chunk-35XJNMFU.js.map +1 -0
- package/dist/chunk-3QH5DUA2.js +6 -0
- package/dist/chunk-3QH5DUA2.js.map +1 -0
- package/dist/chunk-5ZH3XGLJ.cjs +1134 -0
- package/dist/chunk-5ZH3XGLJ.cjs.map +1 -0
- package/dist/chunk-B3QB5WPI.cjs +202 -0
- package/dist/chunk-B3QB5WPI.cjs.map +1 -0
- package/dist/chunk-DO6A7FLM.js +1103 -0
- package/dist/chunk-DO6A7FLM.js.map +1 -0
- package/dist/chunk-LLPMUDNE.cjs +16 -0
- package/dist/chunk-LLPMUDNE.cjs.map +1 -0
- package/dist/chunk-LPQFS6AS.cjs +8 -0
- package/dist/chunk-LPQFS6AS.cjs.map +1 -0
- package/dist/chunk-T4ZQXFTN.js +181 -0
- package/dist/chunk-T4ZQXFTN.js.map +1 -0
- package/dist/client-CrTIZPmY.d.cts +3074 -0
- package/dist/client-DJApW4Uf.d.ts +3074 -0
- package/dist/error-D1uHhe6r.d.cts +205 -0
- package/dist/error-D1uHhe6r.d.ts +205 -0
- package/dist/index.cjs +1741 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +22 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.js +1638 -0
- package/dist/index.js.map +1 -0
- package/dist/media-profile-DZCqLJKa.d.cts +492 -0
- package/dist/media-profile-DZCqLJKa.d.ts +492 -0
- package/dist/solapi/index.cjs +684 -0
- package/dist/solapi/index.cjs.map +1 -0
- package/dist/solapi/index.d.cts +282 -0
- package/dist/solapi/index.d.ts +282 -0
- package/dist/solapi/index.js +673 -0
- package/dist/solapi/index.js.map +1 -0
- package/package.json +121 -4
|
@@ -0,0 +1,3074 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { C as ClawOpsError } from './error-D1uHhe6r.js';
|
|
3
|
+
|
|
4
|
+
interface APIClientOptions {
|
|
5
|
+
apiKey: string;
|
|
6
|
+
baseURL?: string;
|
|
7
|
+
timeout?: number;
|
|
8
|
+
maxRetries?: number;
|
|
9
|
+
fetch?: typeof globalThis.fetch;
|
|
10
|
+
defaultHeaders?: Record<string, string>;
|
|
11
|
+
}
|
|
12
|
+
declare class APIClient {
|
|
13
|
+
protected _apiKey: string;
|
|
14
|
+
protected _baseURL: string;
|
|
15
|
+
protected _maxRetries: number;
|
|
16
|
+
protected _timeout: number;
|
|
17
|
+
protected _fetch: typeof globalThis.fetch;
|
|
18
|
+
protected _defaultHeaders: Record<string, string>;
|
|
19
|
+
constructor(options: APIClientOptions);
|
|
20
|
+
private _buildHeaders;
|
|
21
|
+
protected _send(method: string, path: string, options?: {
|
|
22
|
+
/** `FormData` 면 그대로 보낸다(multipart) — 직렬화도 Content-Type 도 건드리지 않는다. */
|
|
23
|
+
body?: Record<string, unknown> | FormData | null;
|
|
24
|
+
query?: Record<string, unknown> | null;
|
|
25
|
+
extraHeaders?: Record<string, string>;
|
|
26
|
+
extraQuery?: Record<string, unknown>;
|
|
27
|
+
timeout?: number;
|
|
28
|
+
}): Promise<Response>;
|
|
29
|
+
protected _request<T>(method: string, path: string, options?: {
|
|
30
|
+
/** `FormData` 면 그대로 보낸다(multipart) — 직렬화도 Content-Type 도 건드리지 않는다. */
|
|
31
|
+
body?: Record<string, unknown> | FormData | null;
|
|
32
|
+
query?: Record<string, unknown> | null;
|
|
33
|
+
castTo?: z.ZodType<T>;
|
|
34
|
+
extraHeaders?: Record<string, string>;
|
|
35
|
+
extraQuery?: Record<string, unknown>;
|
|
36
|
+
timeout?: number;
|
|
37
|
+
}): Promise<T | null>;
|
|
38
|
+
private _shouldRetry;
|
|
39
|
+
private _retryDelay;
|
|
40
|
+
private _sleep;
|
|
41
|
+
_get<T>(path: string, options: {
|
|
42
|
+
castTo: z.ZodType<T>;
|
|
43
|
+
query?: Record<string, unknown> | null;
|
|
44
|
+
extraHeaders?: Record<string, string>;
|
|
45
|
+
extraQuery?: Record<string, unknown>;
|
|
46
|
+
timeout?: number;
|
|
47
|
+
}): Promise<T>;
|
|
48
|
+
_post<T>(path: string, options: {
|
|
49
|
+
/** `FormData` 면 그대로 보낸다(multipart) — 직렬화도 Content-Type 도 건드리지 않는다. */
|
|
50
|
+
body?: Record<string, unknown> | FormData | null;
|
|
51
|
+
castTo: z.ZodType<T>;
|
|
52
|
+
extraHeaders?: Record<string, string>;
|
|
53
|
+
extraQuery?: Record<string, unknown>;
|
|
54
|
+
timeout?: number;
|
|
55
|
+
}): Promise<T>;
|
|
56
|
+
_put<T>(path: string, options: {
|
|
57
|
+
body?: Record<string, unknown> | null;
|
|
58
|
+
castTo: z.ZodType<T>;
|
|
59
|
+
extraHeaders?: Record<string, string>;
|
|
60
|
+
extraQuery?: Record<string, unknown>;
|
|
61
|
+
timeout?: number;
|
|
62
|
+
}): Promise<T>;
|
|
63
|
+
_patch<T>(path: string, options: {
|
|
64
|
+
body?: Record<string, unknown> | null;
|
|
65
|
+
castTo: z.ZodType<T>;
|
|
66
|
+
extraHeaders?: Record<string, string>;
|
|
67
|
+
extraQuery?: Record<string, unknown>;
|
|
68
|
+
timeout?: number;
|
|
69
|
+
}): Promise<T>;
|
|
70
|
+
_getRaw(path: string, options?: {
|
|
71
|
+
query?: Record<string, unknown> | null;
|
|
72
|
+
extraHeaders?: Record<string, string>;
|
|
73
|
+
extraQuery?: Record<string, unknown>;
|
|
74
|
+
timeout?: number;
|
|
75
|
+
}): Promise<Response>;
|
|
76
|
+
/**
|
|
77
|
+
* 본문을 돌려주는 DELETE. 기존 `_delete` 는 void 라 응답을 버리는데, soft delete 처럼
|
|
78
|
+
* 삭제 결과 리소스를 그대로 반환하는 endpoint 가 있어서 따로 둔다.
|
|
79
|
+
*/
|
|
80
|
+
_deleteWithResponse<T>(path: string, options: {
|
|
81
|
+
body?: Record<string, unknown> | null;
|
|
82
|
+
castTo: z.ZodType<T>;
|
|
83
|
+
extraHeaders?: Record<string, string>;
|
|
84
|
+
extraQuery?: Record<string, unknown>;
|
|
85
|
+
timeout?: number;
|
|
86
|
+
}): Promise<T>;
|
|
87
|
+
_delete(path: string, options?: {
|
|
88
|
+
extraHeaders?: Record<string, string>;
|
|
89
|
+
timeout?: number;
|
|
90
|
+
}): Promise<void>;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
declare class APIResource {
|
|
94
|
+
protected _client: APIClient;
|
|
95
|
+
protected _accountId: string;
|
|
96
|
+
constructor(client: APIClient, accountId: string);
|
|
97
|
+
protected get _basePath(): string;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
declare class Page<T> {
|
|
101
|
+
data: T[];
|
|
102
|
+
meta: {
|
|
103
|
+
total: number;
|
|
104
|
+
page: number;
|
|
105
|
+
pageSize: number;
|
|
106
|
+
};
|
|
107
|
+
private _client;
|
|
108
|
+
private _path;
|
|
109
|
+
private _itemSchema;
|
|
110
|
+
private _query;
|
|
111
|
+
constructor(data: T[], meta: {
|
|
112
|
+
total: number;
|
|
113
|
+
page: number;
|
|
114
|
+
pageSize: number;
|
|
115
|
+
});
|
|
116
|
+
/** @internal */
|
|
117
|
+
_setClient(client: APIClient, path: string, itemSchema: z.ZodType<T>, query: Record<string, unknown>): void;
|
|
118
|
+
hasNextPage(): boolean;
|
|
119
|
+
nextPage(): Promise<Page<T>>;
|
|
120
|
+
[Symbol.iterator](): Iterator<T>;
|
|
121
|
+
autoPagingIter(): AsyncGenerator<T>;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
declare const AssignmentLinkAssignmentSchema: z.ZodObject<{
|
|
125
|
+
number: z.ZodString;
|
|
126
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
127
|
+
consumedAt: z.ZodString;
|
|
128
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
129
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
130
|
+
number: z.ZodString;
|
|
131
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
132
|
+
consumedAt: z.ZodString;
|
|
133
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
134
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
135
|
+
number: z.ZodString;
|
|
136
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
137
|
+
consumedAt: z.ZodString;
|
|
138
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
139
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
140
|
+
declare const AssignmentLinkSchema: z.ZodObject<{
|
|
141
|
+
linkId: z.ZodString;
|
|
142
|
+
url: z.ZodString;
|
|
143
|
+
status: z.ZodEnum<["pending", "consumed", "expired", "revoked"]>;
|
|
144
|
+
createdAt: z.ZodString;
|
|
145
|
+
expiresAt: z.ZodString;
|
|
146
|
+
consumedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
147
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
148
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
|
|
149
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
150
|
+
assignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
151
|
+
number: z.ZodString;
|
|
152
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
153
|
+
consumedAt: z.ZodString;
|
|
154
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
155
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
156
|
+
number: z.ZodString;
|
|
157
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
158
|
+
consumedAt: z.ZodString;
|
|
159
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
160
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
161
|
+
number: z.ZodString;
|
|
162
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
163
|
+
consumedAt: z.ZodString;
|
|
164
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
165
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
166
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
167
|
+
linkId: z.ZodString;
|
|
168
|
+
url: z.ZodString;
|
|
169
|
+
status: z.ZodEnum<["pending", "consumed", "expired", "revoked"]>;
|
|
170
|
+
createdAt: z.ZodString;
|
|
171
|
+
expiresAt: z.ZodString;
|
|
172
|
+
consumedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
173
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
174
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
|
|
175
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
176
|
+
assignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
177
|
+
number: z.ZodString;
|
|
178
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
179
|
+
consumedAt: z.ZodString;
|
|
180
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
181
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
182
|
+
number: z.ZodString;
|
|
183
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
184
|
+
consumedAt: z.ZodString;
|
|
185
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
186
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
187
|
+
number: z.ZodString;
|
|
188
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
189
|
+
consumedAt: z.ZodString;
|
|
190
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
191
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
192
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
193
|
+
linkId: z.ZodString;
|
|
194
|
+
url: z.ZodString;
|
|
195
|
+
status: z.ZodEnum<["pending", "consumed", "expired", "revoked"]>;
|
|
196
|
+
createdAt: z.ZodString;
|
|
197
|
+
expiresAt: z.ZodString;
|
|
198
|
+
consumedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
199
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
200
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
|
|
201
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
202
|
+
assignment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
203
|
+
number: z.ZodString;
|
|
204
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
205
|
+
consumedAt: z.ZodString;
|
|
206
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
207
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
208
|
+
number: z.ZodString;
|
|
209
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
210
|
+
consumedAt: z.ZodString;
|
|
211
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
212
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
213
|
+
number: z.ZodString;
|
|
214
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
215
|
+
consumedAt: z.ZodString;
|
|
216
|
+
releasedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
217
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
218
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
219
|
+
declare const AssignmentLinkCreateResponseSchema: z.ZodObject<{
|
|
220
|
+
token: z.ZodString;
|
|
221
|
+
url: z.ZodString;
|
|
222
|
+
expiresAt: z.ZodString;
|
|
223
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
224
|
+
token: z.ZodString;
|
|
225
|
+
url: z.ZodString;
|
|
226
|
+
expiresAt: z.ZodString;
|
|
227
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
228
|
+
token: z.ZodString;
|
|
229
|
+
url: z.ZodString;
|
|
230
|
+
expiresAt: z.ZodString;
|
|
231
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
232
|
+
type AssignmentLinkAssignment = z.infer<typeof AssignmentLinkAssignmentSchema>;
|
|
233
|
+
type AssignmentLink = z.infer<typeof AssignmentLinkSchema>;
|
|
234
|
+
type AssignmentLinkCreateResponse = z.infer<typeof AssignmentLinkCreateResponseSchema>;
|
|
235
|
+
type AssignmentLinkStatus = AssignmentLink['status'];
|
|
236
|
+
|
|
237
|
+
type RequestOptions$4 = {
|
|
238
|
+
extraHeaders?: Record<string, string>;
|
|
239
|
+
extraQuery?: Record<string, unknown>;
|
|
240
|
+
timeout?: number;
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* 관리번호(External Assignment) 발급 링크 리소스.
|
|
244
|
+
*
|
|
245
|
+
* POST/DELETE는 `external_assignment` 애드온이 활성화된 계정에서만 가능합니다.
|
|
246
|
+
* GET 조회는 애드온 활성 여부와 무관하게 가능합니다.
|
|
247
|
+
*/
|
|
248
|
+
declare class AssignmentLinks extends APIResource {
|
|
249
|
+
create(params?: {
|
|
250
|
+
webhookUrl?: string;
|
|
251
|
+
webhookMethod?: 'POST' | 'GET';
|
|
252
|
+
note?: string;
|
|
253
|
+
}, options?: RequestOptions$4): Promise<AssignmentLinkCreateResponse>;
|
|
254
|
+
list(params?: {
|
|
255
|
+
status?: AssignmentLinkStatus;
|
|
256
|
+
page?: number;
|
|
257
|
+
pageSize?: number;
|
|
258
|
+
}, options?: RequestOptions$4): Promise<Page<AssignmentLink>>;
|
|
259
|
+
retrieve(linkId: string, options?: RequestOptions$4): Promise<AssignmentLink>;
|
|
260
|
+
revoke(linkId: string, options?: {
|
|
261
|
+
extraHeaders?: Record<string, string>;
|
|
262
|
+
timeout?: number;
|
|
263
|
+
}): Promise<void>;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
declare const BlockedRecipientSchema: z.ZodObject<{
|
|
267
|
+
id: z.ZodString;
|
|
268
|
+
/**
|
|
269
|
+
* 수신거부한 상대. **채널과 무관하게 항상 이 칸에 들어갑니다** —
|
|
270
|
+
* `call`·`message` 면 국내 표기로 정규화된 전화번호(예 `'01012345678'`),
|
|
271
|
+
* `email` 이면 소문자로 정규화된 이메일 주소(예 `'kim@example.com'`).
|
|
272
|
+
*
|
|
273
|
+
* 채널이 늘어도 이 칸 하나만 읽으면 됩니다.
|
|
274
|
+
*/
|
|
275
|
+
recipient: z.ZodString;
|
|
276
|
+
/**
|
|
277
|
+
* ⚠️ `email` 이 2026-09-07 에 추가됐습니다. 이 값을 **enum 으로 좁히지 마세요** —
|
|
278
|
+
* 서버가 채널을 늘리면 옛 SDK 가 파싱 단계에서 통째로 실패합니다. 실제로 그 일이
|
|
279
|
+
* 있었습니다: `['call','message']` 로 굳혀 둔 탓에, 이메일 항목이 하나라도 섞이면
|
|
280
|
+
* 목록 조회 전체가 깨졌습니다. 알려진 값은 `BlockedChannel` 로 노출하되 파싱은
|
|
281
|
+
* 열어 둡니다.
|
|
282
|
+
*/
|
|
283
|
+
channel: z.ZodString;
|
|
284
|
+
/** 지금 차단 중인지. 해제분도 이력으로 조회되므로 이 값으로 구분한다. */
|
|
285
|
+
active: z.ZodBoolean;
|
|
286
|
+
source: z.ZodString;
|
|
287
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
288
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
289
|
+
createdBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
290
|
+
createdAt: z.ZodString;
|
|
291
|
+
updatedAt: z.ZodString;
|
|
292
|
+
unblockedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
293
|
+
unblockedSource: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
294
|
+
unblockedBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
295
|
+
unblockedNote: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
296
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
297
|
+
id: z.ZodString;
|
|
298
|
+
/**
|
|
299
|
+
* 수신거부한 상대. **채널과 무관하게 항상 이 칸에 들어갑니다** —
|
|
300
|
+
* `call`·`message` 면 국내 표기로 정규화된 전화번호(예 `'01012345678'`),
|
|
301
|
+
* `email` 이면 소문자로 정규화된 이메일 주소(예 `'kim@example.com'`).
|
|
302
|
+
*
|
|
303
|
+
* 채널이 늘어도 이 칸 하나만 읽으면 됩니다.
|
|
304
|
+
*/
|
|
305
|
+
recipient: z.ZodString;
|
|
306
|
+
/**
|
|
307
|
+
* ⚠️ `email` 이 2026-09-07 에 추가됐습니다. 이 값을 **enum 으로 좁히지 마세요** —
|
|
308
|
+
* 서버가 채널을 늘리면 옛 SDK 가 파싱 단계에서 통째로 실패합니다. 실제로 그 일이
|
|
309
|
+
* 있었습니다: `['call','message']` 로 굳혀 둔 탓에, 이메일 항목이 하나라도 섞이면
|
|
310
|
+
* 목록 조회 전체가 깨졌습니다. 알려진 값은 `BlockedChannel` 로 노출하되 파싱은
|
|
311
|
+
* 열어 둡니다.
|
|
312
|
+
*/
|
|
313
|
+
channel: z.ZodString;
|
|
314
|
+
/** 지금 차단 중인지. 해제분도 이력으로 조회되므로 이 값으로 구분한다. */
|
|
315
|
+
active: z.ZodBoolean;
|
|
316
|
+
source: z.ZodString;
|
|
317
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
318
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
319
|
+
createdBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
320
|
+
createdAt: z.ZodString;
|
|
321
|
+
updatedAt: z.ZodString;
|
|
322
|
+
unblockedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
323
|
+
unblockedSource: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
324
|
+
unblockedBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
325
|
+
unblockedNote: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
326
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
327
|
+
id: z.ZodString;
|
|
328
|
+
/**
|
|
329
|
+
* 수신거부한 상대. **채널과 무관하게 항상 이 칸에 들어갑니다** —
|
|
330
|
+
* `call`·`message` 면 국내 표기로 정규화된 전화번호(예 `'01012345678'`),
|
|
331
|
+
* `email` 이면 소문자로 정규화된 이메일 주소(예 `'kim@example.com'`).
|
|
332
|
+
*
|
|
333
|
+
* 채널이 늘어도 이 칸 하나만 읽으면 됩니다.
|
|
334
|
+
*/
|
|
335
|
+
recipient: z.ZodString;
|
|
336
|
+
/**
|
|
337
|
+
* ⚠️ `email` 이 2026-09-07 에 추가됐습니다. 이 값을 **enum 으로 좁히지 마세요** —
|
|
338
|
+
* 서버가 채널을 늘리면 옛 SDK 가 파싱 단계에서 통째로 실패합니다. 실제로 그 일이
|
|
339
|
+
* 있었습니다: `['call','message']` 로 굳혀 둔 탓에, 이메일 항목이 하나라도 섞이면
|
|
340
|
+
* 목록 조회 전체가 깨졌습니다. 알려진 값은 `BlockedChannel` 로 노출하되 파싱은
|
|
341
|
+
* 열어 둡니다.
|
|
342
|
+
*/
|
|
343
|
+
channel: z.ZodString;
|
|
344
|
+
/** 지금 차단 중인지. 해제분도 이력으로 조회되므로 이 값으로 구분한다. */
|
|
345
|
+
active: z.ZodBoolean;
|
|
346
|
+
source: z.ZodString;
|
|
347
|
+
sourceRef: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
348
|
+
note: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
349
|
+
createdBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
350
|
+
createdAt: z.ZodString;
|
|
351
|
+
updatedAt: z.ZodString;
|
|
352
|
+
unblockedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
353
|
+
unblockedSource: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
354
|
+
unblockedBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
355
|
+
unblockedNote: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
356
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
357
|
+
type BlockedRecipient = z.infer<typeof BlockedRecipientSchema>;
|
|
358
|
+
/**
|
|
359
|
+
* 차단 채널. `call`=전화, `message`=문자(SMS/LMS/MMS 공통), `email`=이메일.
|
|
360
|
+
*
|
|
361
|
+
* 같은 상대라도 채널마다 별개 항목입니다 — 전화와 이메일을 모두 막으려면 두 번 등록합니다.
|
|
362
|
+
*
|
|
363
|
+
* ⚠️ 응답의 `channel` 은 `string` 입니다(위 참조). 이 타입은 **요청을 쓸 때의 도움말**이고,
|
|
364
|
+
* `(string & {})` 를 유니온에 두어 서버가 새 채널을 내놔도 타입이 막지 않게 했습니다.
|
|
365
|
+
*/
|
|
366
|
+
type BlockedChannel = 'call' | 'message' | 'email' | (string & {});
|
|
367
|
+
type BlockedRecipientStatus = 'active' | 'released' | 'all';
|
|
368
|
+
/**
|
|
369
|
+
* 접수 경로. 공개 API 로 등록하면 이 넷 중 하나입니다.
|
|
370
|
+
*
|
|
371
|
+
* ⚠️ 응답에는 **여기 없는 값도 옵니다** — `ars`(ARS 수신거부 9번), `sms`(문자 회신) 처럼
|
|
372
|
+
* 내부 접수 경로로 들어온 항목이 그렇습니다. 그래서 응답의 `source` 는 `string` 입니다.
|
|
373
|
+
*/
|
|
374
|
+
type BlockedRecipientSource = 'api' | 'console' | 'import' | 'agent';
|
|
375
|
+
|
|
376
|
+
type RequestOptions$3 = {
|
|
377
|
+
extraHeaders?: Record<string, string>;
|
|
378
|
+
extraQuery?: Record<string, unknown>;
|
|
379
|
+
timeout?: number;
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* 수신거부(DNC) 명단 리소스.
|
|
383
|
+
*
|
|
384
|
+
* 등록된 대상은 이 계정의 **발신**(전화·문자·이메일)에서 제외됩니다. 착신은 막지 않습니다 —
|
|
385
|
+
* 그 번호에서 걸려오는 전화도, 그 주소에서 오는 메일도 그대로 받습니다.
|
|
386
|
+
*
|
|
387
|
+
* 채널은 각각 따로 차단합니다. 같은 상대라도 채널마다 별개 항목이므로, 전화와 이메일을
|
|
388
|
+
* 모두 막으려면 `channel` 을 바꿔 두 번 등록합니다.
|
|
389
|
+
*
|
|
390
|
+
* ⚠️ **채널마다 막는 방식이 다릅니다.**
|
|
391
|
+
* - 전화·문자: 수신거부 대상이면 그 발신 요청 **전체**가 `422 recipient_blocked` 로 거절됩니다.
|
|
392
|
+
* - 이메일: 차단된 수신자만 **빼고 나머지에게는 보냅니다.** 응답의 `suppressed` 에 빠진
|
|
393
|
+
* 주소가 담기므로, `2xx` 를 받아도 그 칸을 확인해야 누가 안 갔는지 알 수 있습니다.
|
|
394
|
+
* 수신자가 전원 걸렸을 때만 `422` 입니다.
|
|
395
|
+
*/
|
|
396
|
+
declare class BlockedRecipients extends APIResource {
|
|
397
|
+
/**
|
|
398
|
+
* 수신거부 명단에 등록합니다.
|
|
399
|
+
*
|
|
400
|
+
* `recipient` 의 형식은 `channel` 이 정합니다 — `call`·`message` 는 **전화번호**(하이픈·`+82`
|
|
401
|
+
* 표기 모두 허용, 국내 표기로 정규화되어 저장), `email` 은 **이메일 주소**(소문자로 정규화).
|
|
402
|
+
*
|
|
403
|
+
* **멱등입니다** — 이미 차단 중인 (대상, 채널)을 다시 등록해도 에러가 아니라 기존 항목을
|
|
404
|
+
* 돌려줍니다. 같은 사람이 수신거부를 두 번 요청하는 것은 정상 상황이기 때문입니다.
|
|
405
|
+
*/
|
|
406
|
+
create(params: {
|
|
407
|
+
recipient: string;
|
|
408
|
+
channel: BlockedChannel;
|
|
409
|
+
source?: BlockedRecipientSource;
|
|
410
|
+
sourceRef?: string;
|
|
411
|
+
note?: string;
|
|
412
|
+
}, options?: RequestOptions$3): Promise<BlockedRecipient>;
|
|
413
|
+
/**
|
|
414
|
+
* 수신거부 목록을 조회합니다. 기본은 **현재 차단 중인 항목만** 이며,
|
|
415
|
+
* 해제 이력까지 보려면 `status` 를 `'released'` 또는 `'all'` 로 지정합니다.
|
|
416
|
+
*/
|
|
417
|
+
list(params?: {
|
|
418
|
+
channel?: BlockedChannel;
|
|
419
|
+
recipient?: string;
|
|
420
|
+
status?: BlockedRecipientStatus;
|
|
421
|
+
page?: number;
|
|
422
|
+
pageSize?: number;
|
|
423
|
+
}, options?: RequestOptions$3): Promise<Page<BlockedRecipient>>;
|
|
424
|
+
/** 항목 상세를 조회합니다. 해제된 항목도 이력으로 남아 조회됩니다(`active: false`). */
|
|
425
|
+
retrieve(blockId: string, options?: RequestOptions$3): Promise<BlockedRecipient>;
|
|
426
|
+
/**
|
|
427
|
+
* 메모를 수정합니다.
|
|
428
|
+
*
|
|
429
|
+
* 번호와 채널은 바꿀 수 없습니다 — 바꾸면 "누가 무엇을 언제 거부했는가"라는 증빙이
|
|
430
|
+
* 뒤틀립니다. 잘못 등록했다면 해제한 뒤 올바른 번호로 새로 등록하세요.
|
|
431
|
+
*/
|
|
432
|
+
update(blockId: string, params?: {
|
|
433
|
+
note?: string | null;
|
|
434
|
+
}, options?: RequestOptions$3): Promise<BlockedRecipient>;
|
|
435
|
+
/**
|
|
436
|
+
* 수신거부를 해제해 다시 발신할 수 있게 합니다.
|
|
437
|
+
*
|
|
438
|
+
* **항목은 삭제되지 않습니다.** `active` 가 false 가 되고 `unblockedAt` 이 기록될 뿐,
|
|
439
|
+
* 행은 이력으로 남습니다 — 언제 거부했고 언제 풀렸는지가 곧 증빙이기 때문입니다.
|
|
440
|
+
* 해제분은 `list({ status: 'released' })` 로 볼 수 있습니다.
|
|
441
|
+
*
|
|
442
|
+
* 이미 해제된 항목에 다시 호출해도 성공하며, 최초 해제 시각은 덮어쓰지 않습니다.
|
|
443
|
+
*/
|
|
444
|
+
release(blockId: string, params?: {
|
|
445
|
+
note?: string;
|
|
446
|
+
}, options?: RequestOptions$3): Promise<BlockedRecipient>;
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
/**
|
|
450
|
+
* 문자 발신번호(clawops#1489). 문자는 등록해 승인된 발신번호로만 보낼 수 있습니다.
|
|
451
|
+
*
|
|
452
|
+
* `type`·`verificationMethod`·`status` 는 enum 으로 좁히지 않습니다 — 서버가 값을 늘려도
|
|
453
|
+
* 목록 조회가 파싱 단계에서 깨지지 않게 하려는 것입니다(`BlockedRecipient.channel` 과 같은 이유).
|
|
454
|
+
*/
|
|
455
|
+
declare const SenderNumberSchema: z.ZodObject<{
|
|
456
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
457
|
+
id: z.ZodString;
|
|
458
|
+
/** 발신번호(숫자만). */
|
|
459
|
+
number: z.ZodString;
|
|
460
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
461
|
+
type: z.ZodString;
|
|
462
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
463
|
+
verificationMethod: z.ZodString;
|
|
464
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
465
|
+
status: z.ZodString;
|
|
466
|
+
createdAt: z.ZodString;
|
|
467
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
468
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
469
|
+
id: z.ZodString;
|
|
470
|
+
/** 발신번호(숫자만). */
|
|
471
|
+
number: z.ZodString;
|
|
472
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
473
|
+
type: z.ZodString;
|
|
474
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
475
|
+
verificationMethod: z.ZodString;
|
|
476
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
477
|
+
status: z.ZodString;
|
|
478
|
+
createdAt: z.ZodString;
|
|
479
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
480
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
481
|
+
id: z.ZodString;
|
|
482
|
+
/** 발신번호(숫자만). */
|
|
483
|
+
number: z.ZodString;
|
|
484
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
485
|
+
type: z.ZodString;
|
|
486
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
487
|
+
verificationMethod: z.ZodString;
|
|
488
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
489
|
+
status: z.ZodString;
|
|
490
|
+
createdAt: z.ZodString;
|
|
491
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
492
|
+
type SenderNumber = z.infer<typeof SenderNumberSchema>;
|
|
493
|
+
/** 등록하지 않았지만 유예 기간이라 `expiresAt` 전까지 보낼 수 있는 번호. */
|
|
494
|
+
declare const SenderNumberGraceSchema: z.ZodObject<{
|
|
495
|
+
number: z.ZodString;
|
|
496
|
+
expiresAt: z.ZodString;
|
|
497
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
498
|
+
number: z.ZodString;
|
|
499
|
+
expiresAt: z.ZodString;
|
|
500
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
501
|
+
number: z.ZodString;
|
|
502
|
+
expiresAt: z.ZodString;
|
|
503
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
504
|
+
type SenderNumberGrace = z.infer<typeof SenderNumberGraceSchema>;
|
|
505
|
+
/**
|
|
506
|
+
* 070번호·대표번호 회선 수 한도. 계정이 아니라 명의 기준이라 같은 명의의 다른 계정 등록분도 셉니다.
|
|
507
|
+
* `limit` 이 `null` 이면 한도가 아직 정해지지 않았습니다(법인 종사자 수 증빙 전).
|
|
508
|
+
*/
|
|
509
|
+
declare const SenderNumberLimitSchema: z.ZodObject<{
|
|
510
|
+
used: z.ZodNumber;
|
|
511
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
512
|
+
reached: z.ZodBoolean;
|
|
513
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
514
|
+
used: z.ZodNumber;
|
|
515
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
516
|
+
reached: z.ZodBoolean;
|
|
517
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
518
|
+
used: z.ZodNumber;
|
|
519
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
520
|
+
reached: z.ZodBoolean;
|
|
521
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
522
|
+
type SenderNumberLimit = z.infer<typeof SenderNumberLimitSchema>;
|
|
523
|
+
declare const SenderNumberListSchema: z.ZodObject<{
|
|
524
|
+
senderNumbers: z.ZodArray<z.ZodObject<{
|
|
525
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
526
|
+
id: z.ZodString;
|
|
527
|
+
/** 발신번호(숫자만). */
|
|
528
|
+
number: z.ZodString;
|
|
529
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
530
|
+
type: z.ZodString;
|
|
531
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
532
|
+
verificationMethod: z.ZodString;
|
|
533
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
534
|
+
status: z.ZodString;
|
|
535
|
+
createdAt: z.ZodString;
|
|
536
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
537
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
538
|
+
id: z.ZodString;
|
|
539
|
+
/** 발신번호(숫자만). */
|
|
540
|
+
number: z.ZodString;
|
|
541
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
542
|
+
type: z.ZodString;
|
|
543
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
544
|
+
verificationMethod: z.ZodString;
|
|
545
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
546
|
+
status: z.ZodString;
|
|
547
|
+
createdAt: z.ZodString;
|
|
548
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
549
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
550
|
+
id: z.ZodString;
|
|
551
|
+
/** 발신번호(숫자만). */
|
|
552
|
+
number: z.ZodString;
|
|
553
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
554
|
+
type: z.ZodString;
|
|
555
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
556
|
+
verificationMethod: z.ZodString;
|
|
557
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
558
|
+
status: z.ZodString;
|
|
559
|
+
createdAt: z.ZodString;
|
|
560
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
561
|
+
grace: z.ZodArray<z.ZodObject<{
|
|
562
|
+
number: z.ZodString;
|
|
563
|
+
expiresAt: z.ZodString;
|
|
564
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
565
|
+
number: z.ZodString;
|
|
566
|
+
expiresAt: z.ZodString;
|
|
567
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
568
|
+
number: z.ZodString;
|
|
569
|
+
expiresAt: z.ZodString;
|
|
570
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
571
|
+
/** 명의를 확인할 수 없으면 `null`. */
|
|
572
|
+
limit: z.ZodNullable<z.ZodObject<{
|
|
573
|
+
used: z.ZodNumber;
|
|
574
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
575
|
+
reached: z.ZodBoolean;
|
|
576
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
577
|
+
used: z.ZodNumber;
|
|
578
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
579
|
+
reached: z.ZodBoolean;
|
|
580
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
581
|
+
used: z.ZodNumber;
|
|
582
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
583
|
+
reached: z.ZodBoolean;
|
|
584
|
+
}, z.ZodTypeAny, "passthrough">>>;
|
|
585
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
586
|
+
senderNumbers: z.ZodArray<z.ZodObject<{
|
|
587
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
588
|
+
id: z.ZodString;
|
|
589
|
+
/** 발신번호(숫자만). */
|
|
590
|
+
number: z.ZodString;
|
|
591
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
592
|
+
type: z.ZodString;
|
|
593
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
594
|
+
verificationMethod: z.ZodString;
|
|
595
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
596
|
+
status: z.ZodString;
|
|
597
|
+
createdAt: z.ZodString;
|
|
598
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
599
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
600
|
+
id: z.ZodString;
|
|
601
|
+
/** 발신번호(숫자만). */
|
|
602
|
+
number: z.ZodString;
|
|
603
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
604
|
+
type: z.ZodString;
|
|
605
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
606
|
+
verificationMethod: z.ZodString;
|
|
607
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
608
|
+
status: z.ZodString;
|
|
609
|
+
createdAt: z.ZodString;
|
|
610
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
611
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
612
|
+
id: z.ZodString;
|
|
613
|
+
/** 발신번호(숫자만). */
|
|
614
|
+
number: z.ZodString;
|
|
615
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
616
|
+
type: z.ZodString;
|
|
617
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
618
|
+
verificationMethod: z.ZodString;
|
|
619
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
620
|
+
status: z.ZodString;
|
|
621
|
+
createdAt: z.ZodString;
|
|
622
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
623
|
+
grace: z.ZodArray<z.ZodObject<{
|
|
624
|
+
number: z.ZodString;
|
|
625
|
+
expiresAt: z.ZodString;
|
|
626
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
627
|
+
number: z.ZodString;
|
|
628
|
+
expiresAt: z.ZodString;
|
|
629
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
630
|
+
number: z.ZodString;
|
|
631
|
+
expiresAt: z.ZodString;
|
|
632
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
633
|
+
/** 명의를 확인할 수 없으면 `null`. */
|
|
634
|
+
limit: z.ZodNullable<z.ZodObject<{
|
|
635
|
+
used: z.ZodNumber;
|
|
636
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
637
|
+
reached: z.ZodBoolean;
|
|
638
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
639
|
+
used: z.ZodNumber;
|
|
640
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
641
|
+
reached: z.ZodBoolean;
|
|
642
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
643
|
+
used: z.ZodNumber;
|
|
644
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
645
|
+
reached: z.ZodBoolean;
|
|
646
|
+
}, z.ZodTypeAny, "passthrough">>>;
|
|
647
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
648
|
+
senderNumbers: z.ZodArray<z.ZodObject<{
|
|
649
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
650
|
+
id: z.ZodString;
|
|
651
|
+
/** 발신번호(숫자만). */
|
|
652
|
+
number: z.ZodString;
|
|
653
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
654
|
+
type: z.ZodString;
|
|
655
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
656
|
+
verificationMethod: z.ZodString;
|
|
657
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
658
|
+
status: z.ZodString;
|
|
659
|
+
createdAt: z.ZodString;
|
|
660
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
661
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
662
|
+
id: z.ZodString;
|
|
663
|
+
/** 발신번호(숫자만). */
|
|
664
|
+
number: z.ZodString;
|
|
665
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
666
|
+
type: z.ZodString;
|
|
667
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
668
|
+
verificationMethod: z.ZodString;
|
|
669
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
670
|
+
status: z.ZodString;
|
|
671
|
+
createdAt: z.ZodString;
|
|
672
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
673
|
+
/** 발신번호 id. 삭제할 때 씁니다. */
|
|
674
|
+
id: z.ZodString;
|
|
675
|
+
/** 발신번호(숫자만). */
|
|
676
|
+
number: z.ZodString;
|
|
677
|
+
/** `'070'` | `'representative'`(대표번호) | `'mobile'`(이동전화) */
|
|
678
|
+
type: z.ZodString;
|
|
679
|
+
/** `'own_provisioned'`(ClawOps 개통) | `'identity_verified'`(본인확인 이동전화) | `'usage_cert_ars'`(다른 통신사 대표번호) */
|
|
680
|
+
verificationMethod: z.ZodString;
|
|
681
|
+
/** `'approved'` = 발송에 쓸 수 있음, `'pending'` = 승인 대기 */
|
|
682
|
+
status: z.ZodString;
|
|
683
|
+
createdAt: z.ZodString;
|
|
684
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
685
|
+
grace: z.ZodArray<z.ZodObject<{
|
|
686
|
+
number: z.ZodString;
|
|
687
|
+
expiresAt: z.ZodString;
|
|
688
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
689
|
+
number: z.ZodString;
|
|
690
|
+
expiresAt: z.ZodString;
|
|
691
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
692
|
+
number: z.ZodString;
|
|
693
|
+
expiresAt: z.ZodString;
|
|
694
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
695
|
+
/** 명의를 확인할 수 없으면 `null`. */
|
|
696
|
+
limit: z.ZodNullable<z.ZodObject<{
|
|
697
|
+
used: z.ZodNumber;
|
|
698
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
699
|
+
reached: z.ZodBoolean;
|
|
700
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
701
|
+
used: z.ZodNumber;
|
|
702
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
703
|
+
reached: z.ZodBoolean;
|
|
704
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
705
|
+
used: z.ZodNumber;
|
|
706
|
+
limit: z.ZodNullable<z.ZodNumber>;
|
|
707
|
+
reached: z.ZodBoolean;
|
|
708
|
+
}, z.ZodTypeAny, "passthrough">>>;
|
|
709
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
710
|
+
type SenderNumberList = z.infer<typeof SenderNumberListSchema>;
|
|
711
|
+
/**
|
|
712
|
+
* 번호 발급 응답의 문자 발신번호 자동 등록 결과. `registered` 가 `false` 여도 번호 발급은 성공입니다 —
|
|
713
|
+
* 그 번호로는 아직 문자를 보낼 수 없고, `reason` 을 해결한 뒤 `senderNumbers.create()` 로 등록합니다.
|
|
714
|
+
*
|
|
715
|
+
* `reason` 예: `sender_number_limit_reached`(한도 도달), `sender_number_limit_unknown`(한도 미정),
|
|
716
|
+
* `sender_number_holder_unresolved`(명의 확인 불가), `actor_unknown`, `unexpected`(일시 오류).
|
|
717
|
+
*/
|
|
718
|
+
declare const SmsSenderRegistrationSchema: z.ZodObject<{
|
|
719
|
+
registered: z.ZodBoolean;
|
|
720
|
+
senderNumberId: z.ZodOptional<z.ZodString>;
|
|
721
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
722
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
723
|
+
registered: z.ZodBoolean;
|
|
724
|
+
senderNumberId: z.ZodOptional<z.ZodString>;
|
|
725
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
726
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
727
|
+
registered: z.ZodBoolean;
|
|
728
|
+
senderNumberId: z.ZodOptional<z.ZodString>;
|
|
729
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
730
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
731
|
+
type SmsSenderRegistration = z.infer<typeof SmsSenderRegistrationSchema>;
|
|
732
|
+
|
|
733
|
+
type RequestOptions$2 = {
|
|
734
|
+
extraHeaders?: Record<string, string>;
|
|
735
|
+
extraQuery?: Record<string, unknown>;
|
|
736
|
+
timeout?: number;
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* 문자 발신번호 리소스(clawops#1489).
|
|
740
|
+
*
|
|
741
|
+
* 문자(SMS·LMS·MMS)는 계정에 등록해 승인된 발신번호로만 보낼 수 있습니다. 승인되지 않은 번호를
|
|
742
|
+
* `from` 으로 보내면 `400 from_not_registered` 로 거절됩니다.
|
|
743
|
+
*
|
|
744
|
+
* 번호를 발급(`numbers.create()`)하면 회선 수 한도 안에서 자동으로 등록되며, 결과는 발급 응답의
|
|
745
|
+
* `smsSender` 에 실립니다.
|
|
746
|
+
*
|
|
747
|
+
* ⚠️ 발신번호 범위를 지정한 API 키는 조회만 됩니다 — 등록·삭제는 `403 api_key_sender_numbers_restricted`.
|
|
748
|
+
*/
|
|
749
|
+
declare class SenderNumbers extends APIResource {
|
|
750
|
+
/**
|
|
751
|
+
* 등록된 발신번호(승인·승인 대기), 유예 기간인 번호, 070번호·대표번호 회선 수 한도를 함께 돌려줍니다.
|
|
752
|
+
* 발신번호 범위를 지정한 API 키로 호출하면 그 범위 안의 번호만 보입니다.
|
|
753
|
+
*/
|
|
754
|
+
list(options?: RequestOptions$2): Promise<SenderNumberList>;
|
|
755
|
+
/**
|
|
756
|
+
* 이 계정이 ClawOps에서 개통한 070번호·대표번호를 발신번호로 등록합니다. 등록 즉시 승인됩니다.
|
|
757
|
+
*
|
|
758
|
+
* - 한 번에 한 번호씩 등록합니다. 하이픈·`+82` 표기도 받습니다.
|
|
759
|
+
* - 이미 등록된 번호면 `409 sender_number_already_registered` — 이미 발송에 쓸 수 있는 상태입니다.
|
|
760
|
+
* - 명의별 회선 수 한도를 넘으면 `422 sender_number_limit_reached`.
|
|
761
|
+
*/
|
|
762
|
+
create(params: {
|
|
763
|
+
number: string;
|
|
764
|
+
}, options?: RequestOptions$2): Promise<SenderNumber>;
|
|
765
|
+
/**
|
|
766
|
+
* 발신번호를 삭제합니다. 그 번호로는 바로 문자를 보낼 수 없고(유예도 함께 끝남) 회선 수 한도에서
|
|
767
|
+
* 빠집니다. 번호 자체는 반납되지 않습니다.
|
|
768
|
+
*
|
|
769
|
+
* API 로는 ClawOps에서 개통한 번호(`verificationMethod === 'own_provisioned'`)만 삭제할 수 있습니다 —
|
|
770
|
+
* 그 밖은 `409 sender_number_not_deletable_via_api`(콘솔에서 삭제).
|
|
771
|
+
*/
|
|
772
|
+
delete(senderNumberId: string, options?: RequestOptions$2): Promise<void>;
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* 전환(담당자 연결) 시도 한 건. `GET /calls/{id}` 단건 조회의 `transfers[]` 에만 들어 있다
|
|
777
|
+
* (목록 조회에는 없다). sequence 순으로 정렬돼 있다.
|
|
778
|
+
*
|
|
779
|
+
* 담당자가 받기까지 걸린 시간은 `answeredAt - startedAt` 이다. `connectedAt` 은 warm 전환에서
|
|
780
|
+
* 연결 전 안내가 끝난 뒤 시각이라 그만큼 늦다.
|
|
781
|
+
*
|
|
782
|
+
* 필드는 전부 optional 이다. `Call.transfers` 는 이 스키마로 항목을 검증하지 않는다(받은 값 그대로,
|
|
783
|
+
* `CallSchema` 의 transfers 주석). 이 스키마는 타입의 정본이자 SDK 내부 테스트용이다.
|
|
784
|
+
*/
|
|
785
|
+
declare const TransferLegSchema: z.ZodObject<{
|
|
786
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
787
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
788
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
789
|
+
/** blind / warm / refer / refer-attended. */
|
|
790
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
791
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
792
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
793
|
+
/**
|
|
794
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
795
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
796
|
+
*/
|
|
797
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
798
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
799
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
800
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
801
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
802
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
803
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
804
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
805
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
806
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
807
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
808
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
809
|
+
/**
|
|
810
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
811
|
+
*
|
|
812
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
813
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
814
|
+
*/
|
|
815
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
816
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
817
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
818
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
819
|
+
/**
|
|
820
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
821
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
822
|
+
*/
|
|
823
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
824
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
825
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
826
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
827
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
828
|
+
/** blind / warm / refer / refer-attended. */
|
|
829
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
830
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
831
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
832
|
+
/**
|
|
833
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
834
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
835
|
+
*/
|
|
836
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
837
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
838
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
839
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
840
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
841
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
842
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
843
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
844
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
845
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
846
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
847
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
848
|
+
/**
|
|
849
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
850
|
+
*
|
|
851
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
852
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
853
|
+
*/
|
|
854
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
855
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
856
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
857
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
858
|
+
/**
|
|
859
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
860
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
861
|
+
*/
|
|
862
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
863
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
864
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
865
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
866
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
867
|
+
/** blind / warm / refer / refer-attended. */
|
|
868
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
869
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
870
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
871
|
+
/**
|
|
872
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
873
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
874
|
+
*/
|
|
875
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
876
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
877
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
878
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
879
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
880
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
881
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
882
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
883
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
884
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
885
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
886
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
887
|
+
/**
|
|
888
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
889
|
+
*
|
|
890
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
891
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
892
|
+
*/
|
|
893
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
894
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
895
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
896
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
897
|
+
/**
|
|
898
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
899
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
900
|
+
*/
|
|
901
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
902
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
903
|
+
type TransferLeg = z.infer<typeof TransferLegSchema>;
|
|
904
|
+
declare const CallSchema: z.ZodObject<{
|
|
905
|
+
callId: z.ZodString;
|
|
906
|
+
/**
|
|
907
|
+
* 진행 중: queued / ringing / in-progress.
|
|
908
|
+
* 종료: completed(응답 후 정상 종료) / no-answer(벨은 울렸으나 무응답) / busy(통화중) /
|
|
909
|
+
* rejected(수신 거절) / canceled(응답 전 발신 측 취소) / failed(시스템·망 오류).
|
|
910
|
+
* completed 만이 실제로 연결된 통화를 의미한다.
|
|
911
|
+
*/
|
|
912
|
+
status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed", "busy", "no-answer", "canceled", "rejected"]>;
|
|
913
|
+
to: z.ZodString;
|
|
914
|
+
from: z.ZodString;
|
|
915
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
916
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
917
|
+
recordingUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
918
|
+
/** AMD(machineDetection) 결과 — AMD 켠 발신 통화에만 값 존재. */
|
|
919
|
+
answeredBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<["human", "machine", "unknown"]>>>;
|
|
920
|
+
/**
|
|
921
|
+
* 수신 통화에서 발신자가 번호 표시제한(`*23#` 등)을 걸고 건 통화면 true, 아니면 false.
|
|
922
|
+
* 번호는 `from` 에 그대로 있다. 발신 통화와 2026-09-29 이전의 수신 통화는 null.
|
|
923
|
+
*/
|
|
924
|
+
callerIdRestricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
925
|
+
/**
|
|
926
|
+
* 통화 종료 사유. status 가 왜 그렇게 끝났는지를 구분한다 — 특히 failed 는 결번·망 오류·
|
|
927
|
+
* 시스템 오류를 모두 포함하는 대분류라, 발신 리스트를 정제하려면 status 가 아니라 이 값을 본다.
|
|
928
|
+
*
|
|
929
|
+
* 재시도해도 소용없음: invalid_number(결번) / number_changed / incompatible_destination.
|
|
930
|
+
* 재시도 가치 있음: no_answer / user_busy / temporary_failure / switching_congestion /
|
|
931
|
+
* no_circuit_available / network_out_of_order / destination_out_of_order /
|
|
932
|
+
* recovery_on_timer_expire / resource_unavailable.
|
|
933
|
+
* 그 외: normal_clearing(정상 종료) / caller_canceled / call_rejected / protocol_error /
|
|
934
|
+
* unspecified / app_error·call_stuck(ClawOps 측 오류 — 재시도 권장) / unknown.
|
|
935
|
+
*
|
|
936
|
+
* enum 으로 좁히지 않는다 — 통신망이 새 cause 를 보내면 서버가 값을 넓히는데, 그때마다
|
|
937
|
+
* SDK 릴리즈를 기다려야 파싱되는 구조는 안 된다.
|
|
938
|
+
*/
|
|
939
|
+
hangupCause: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
940
|
+
/** 통신망 Q.850 cause code. 1·5·28=결번, 16=정상해제, 17=통화중, 19=무응답, 38=망장애. */
|
|
941
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
942
|
+
/**
|
|
943
|
+
* 종료를 유발한 SIP 응답코드(404=없는 번호, 486=통화중, 500=망 오류 등).
|
|
944
|
+
* 국내 통신망은 실제 사유를 500 으로 감싸 보내기도 하므로 hangupCause 가 더 정확하다.
|
|
945
|
+
*/
|
|
946
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
947
|
+
/**
|
|
948
|
+
* 종료 책임 주체. carrier(통신망) / callee(수신자) / caller(발신자) /
|
|
949
|
+
* app·system(ClawOps 측 오류 — 수신자 번호를 정제 대상에 넣지 말고 재시도할 것).
|
|
950
|
+
*/
|
|
951
|
+
hangupSource: z.ZodOptional<z.ZodNullable<z.ZodEnum<["carrier", "callee", "caller", "app", "system"]>>>;
|
|
952
|
+
/**
|
|
953
|
+
* 전환(담당자 연결) 요약 — 이 통화의 **대표 시도** 하나에서 나온 값이다. 대표는 **끝난 시도**
|
|
954
|
+
* (completed / failed / busy / no-answer / canceled) 중 completed 우선, 같으면 마지막 시도다.
|
|
955
|
+
*
|
|
956
|
+
* ⚠️ null 이 「전환이 없었다」를 뜻하지 않는다 — 시도가 아직 진행 중이거나 `interrupted` 로만 끝났어도
|
|
957
|
+
* null 이다. 전환 여부는 `transfers` 로 판정할 것.
|
|
958
|
+
*/
|
|
959
|
+
transferTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
960
|
+
transferStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
961
|
+
/** 연결→종료 초(관측값, 과금 초 아님). 연결되지 못했으면 null. */
|
|
962
|
+
transferDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
963
|
+
transferHangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
964
|
+
transferSipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
965
|
+
/**
|
|
966
|
+
* 통신망 원본 진단 텍스트. ⚠️ 위 대표 시도가 아니라 **마지막으로 기록된** 통신망 사유라, 여러 번
|
|
967
|
+
* 시도한 통화에서는 다른 시도의 것일 수 있다(대표 시도는 completed 인데 이 값은 실패 사유인 경우).
|
|
968
|
+
* 시도별 사유는 `transfers[].reasonText` 를 쓴다.
|
|
969
|
+
*/
|
|
970
|
+
transferReasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
971
|
+
/**
|
|
972
|
+
* 전환 시도 전체(sequence 순). **단건 조회(`calls.get`)에만** 있고 그 밖의 응답(목록·생성·수정)에는 없다.
|
|
973
|
+
*
|
|
974
|
+
* 타입은 `TransferLeg` 지만 런타임에서는 항목이 객체인지만 본다 — 이 타입이 생기기 전에는 passthrough 로
|
|
975
|
+
* 받았으므로, 시도 하나의 값 타입이 어긋났다고 `calls.get` 전체가 검증 오류로 실패하면 회귀다.
|
|
976
|
+
*/
|
|
977
|
+
transfers: z.ZodOptional<z.ZodArray<z.ZodType<z.objectOutputType<{
|
|
978
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
979
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
980
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
981
|
+
/** blind / warm / refer / refer-attended. */
|
|
982
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
983
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
984
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
985
|
+
/**
|
|
986
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
987
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
988
|
+
*/
|
|
989
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
990
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
991
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
992
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
993
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
994
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
995
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
996
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
997
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
998
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
999
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1000
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1001
|
+
/**
|
|
1002
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1003
|
+
*
|
|
1004
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1005
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1006
|
+
*/
|
|
1007
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1008
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1009
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1010
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1011
|
+
/**
|
|
1012
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1013
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1014
|
+
*/
|
|
1015
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1016
|
+
}, z.ZodTypeAny, "passthrough">, z.ZodTypeDef, z.objectOutputType<{
|
|
1017
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
1018
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1019
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1020
|
+
/** blind / warm / refer / refer-attended. */
|
|
1021
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1022
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
1023
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1024
|
+
/**
|
|
1025
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
1026
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
1027
|
+
*/
|
|
1028
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1029
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
1030
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1031
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
1032
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
1033
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1034
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1035
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1036
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
1037
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1038
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1039
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1040
|
+
/**
|
|
1041
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1042
|
+
*
|
|
1043
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1044
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1045
|
+
*/
|
|
1046
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1047
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1048
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1049
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1050
|
+
/**
|
|
1051
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1052
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1053
|
+
*/
|
|
1054
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1055
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1056
|
+
accountId: z.ZodString;
|
|
1057
|
+
dateCreated: z.ZodString;
|
|
1058
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1059
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1060
|
+
callId: z.ZodString;
|
|
1061
|
+
/**
|
|
1062
|
+
* 진행 중: queued / ringing / in-progress.
|
|
1063
|
+
* 종료: completed(응답 후 정상 종료) / no-answer(벨은 울렸으나 무응답) / busy(통화중) /
|
|
1064
|
+
* rejected(수신 거절) / canceled(응답 전 발신 측 취소) / failed(시스템·망 오류).
|
|
1065
|
+
* completed 만이 실제로 연결된 통화를 의미한다.
|
|
1066
|
+
*/
|
|
1067
|
+
status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed", "busy", "no-answer", "canceled", "rejected"]>;
|
|
1068
|
+
to: z.ZodString;
|
|
1069
|
+
from: z.ZodString;
|
|
1070
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
1071
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1072
|
+
recordingUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1073
|
+
/** AMD(machineDetection) 결과 — AMD 켠 발신 통화에만 값 존재. */
|
|
1074
|
+
answeredBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<["human", "machine", "unknown"]>>>;
|
|
1075
|
+
/**
|
|
1076
|
+
* 수신 통화에서 발신자가 번호 표시제한(`*23#` 등)을 걸고 건 통화면 true, 아니면 false.
|
|
1077
|
+
* 번호는 `from` 에 그대로 있다. 발신 통화와 2026-09-29 이전의 수신 통화는 null.
|
|
1078
|
+
*/
|
|
1079
|
+
callerIdRestricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
1080
|
+
/**
|
|
1081
|
+
* 통화 종료 사유. status 가 왜 그렇게 끝났는지를 구분한다 — 특히 failed 는 결번·망 오류·
|
|
1082
|
+
* 시스템 오류를 모두 포함하는 대분류라, 발신 리스트를 정제하려면 status 가 아니라 이 값을 본다.
|
|
1083
|
+
*
|
|
1084
|
+
* 재시도해도 소용없음: invalid_number(결번) / number_changed / incompatible_destination.
|
|
1085
|
+
* 재시도 가치 있음: no_answer / user_busy / temporary_failure / switching_congestion /
|
|
1086
|
+
* no_circuit_available / network_out_of_order / destination_out_of_order /
|
|
1087
|
+
* recovery_on_timer_expire / resource_unavailable.
|
|
1088
|
+
* 그 외: normal_clearing(정상 종료) / caller_canceled / call_rejected / protocol_error /
|
|
1089
|
+
* unspecified / app_error·call_stuck(ClawOps 측 오류 — 재시도 권장) / unknown.
|
|
1090
|
+
*
|
|
1091
|
+
* enum 으로 좁히지 않는다 — 통신망이 새 cause 를 보내면 서버가 값을 넓히는데, 그때마다
|
|
1092
|
+
* SDK 릴리즈를 기다려야 파싱되는 구조는 안 된다.
|
|
1093
|
+
*/
|
|
1094
|
+
hangupCause: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1095
|
+
/** 통신망 Q.850 cause code. 1·5·28=결번, 16=정상해제, 17=통화중, 19=무응답, 38=망장애. */
|
|
1096
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1097
|
+
/**
|
|
1098
|
+
* 종료를 유발한 SIP 응답코드(404=없는 번호, 486=통화중, 500=망 오류 등).
|
|
1099
|
+
* 국내 통신망은 실제 사유를 500 으로 감싸 보내기도 하므로 hangupCause 가 더 정확하다.
|
|
1100
|
+
*/
|
|
1101
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1102
|
+
/**
|
|
1103
|
+
* 종료 책임 주체. carrier(통신망) / callee(수신자) / caller(발신자) /
|
|
1104
|
+
* app·system(ClawOps 측 오류 — 수신자 번호를 정제 대상에 넣지 말고 재시도할 것).
|
|
1105
|
+
*/
|
|
1106
|
+
hangupSource: z.ZodOptional<z.ZodNullable<z.ZodEnum<["carrier", "callee", "caller", "app", "system"]>>>;
|
|
1107
|
+
/**
|
|
1108
|
+
* 전환(담당자 연결) 요약 — 이 통화의 **대표 시도** 하나에서 나온 값이다. 대표는 **끝난 시도**
|
|
1109
|
+
* (completed / failed / busy / no-answer / canceled) 중 completed 우선, 같으면 마지막 시도다.
|
|
1110
|
+
*
|
|
1111
|
+
* ⚠️ null 이 「전환이 없었다」를 뜻하지 않는다 — 시도가 아직 진행 중이거나 `interrupted` 로만 끝났어도
|
|
1112
|
+
* null 이다. 전환 여부는 `transfers` 로 판정할 것.
|
|
1113
|
+
*/
|
|
1114
|
+
transferTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1115
|
+
transferStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1116
|
+
/** 연결→종료 초(관측값, 과금 초 아님). 연결되지 못했으면 null. */
|
|
1117
|
+
transferDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1118
|
+
transferHangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1119
|
+
transferSipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1120
|
+
/**
|
|
1121
|
+
* 통신망 원본 진단 텍스트. ⚠️ 위 대표 시도가 아니라 **마지막으로 기록된** 통신망 사유라, 여러 번
|
|
1122
|
+
* 시도한 통화에서는 다른 시도의 것일 수 있다(대표 시도는 completed 인데 이 값은 실패 사유인 경우).
|
|
1123
|
+
* 시도별 사유는 `transfers[].reasonText` 를 쓴다.
|
|
1124
|
+
*/
|
|
1125
|
+
transferReasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1126
|
+
/**
|
|
1127
|
+
* 전환 시도 전체(sequence 순). **단건 조회(`calls.get`)에만** 있고 그 밖의 응답(목록·생성·수정)에는 없다.
|
|
1128
|
+
*
|
|
1129
|
+
* 타입은 `TransferLeg` 지만 런타임에서는 항목이 객체인지만 본다 — 이 타입이 생기기 전에는 passthrough 로
|
|
1130
|
+
* 받았으므로, 시도 하나의 값 타입이 어긋났다고 `calls.get` 전체가 검증 오류로 실패하면 회귀다.
|
|
1131
|
+
*/
|
|
1132
|
+
transfers: z.ZodOptional<z.ZodArray<z.ZodType<z.objectOutputType<{
|
|
1133
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
1134
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1135
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1136
|
+
/** blind / warm / refer / refer-attended. */
|
|
1137
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1138
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
1139
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1140
|
+
/**
|
|
1141
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
1142
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
1143
|
+
*/
|
|
1144
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1145
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
1146
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1147
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
1148
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
1149
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1150
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1151
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1152
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
1153
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1154
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1155
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1156
|
+
/**
|
|
1157
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1158
|
+
*
|
|
1159
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1160
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1161
|
+
*/
|
|
1162
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1163
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1164
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1165
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1166
|
+
/**
|
|
1167
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1168
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1169
|
+
*/
|
|
1170
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1171
|
+
}, z.ZodTypeAny, "passthrough">, z.ZodTypeDef, z.objectOutputType<{
|
|
1172
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
1173
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1174
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1175
|
+
/** blind / warm / refer / refer-attended. */
|
|
1176
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1177
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
1178
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1179
|
+
/**
|
|
1180
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
1181
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
1182
|
+
*/
|
|
1183
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1184
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
1185
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1186
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
1187
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
1188
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1189
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1190
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1191
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
1192
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1193
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1194
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1195
|
+
/**
|
|
1196
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1197
|
+
*
|
|
1198
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1199
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1200
|
+
*/
|
|
1201
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1202
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1203
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1204
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1205
|
+
/**
|
|
1206
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1207
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1208
|
+
*/
|
|
1209
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1210
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1211
|
+
accountId: z.ZodString;
|
|
1212
|
+
dateCreated: z.ZodString;
|
|
1213
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1214
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1215
|
+
callId: z.ZodString;
|
|
1216
|
+
/**
|
|
1217
|
+
* 진행 중: queued / ringing / in-progress.
|
|
1218
|
+
* 종료: completed(응답 후 정상 종료) / no-answer(벨은 울렸으나 무응답) / busy(통화중) /
|
|
1219
|
+
* rejected(수신 거절) / canceled(응답 전 발신 측 취소) / failed(시스템·망 오류).
|
|
1220
|
+
* completed 만이 실제로 연결된 통화를 의미한다.
|
|
1221
|
+
*/
|
|
1222
|
+
status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed", "busy", "no-answer", "canceled", "rejected"]>;
|
|
1223
|
+
to: z.ZodString;
|
|
1224
|
+
from: z.ZodString;
|
|
1225
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
1226
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1227
|
+
recordingUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1228
|
+
/** AMD(machineDetection) 결과 — AMD 켠 발신 통화에만 값 존재. */
|
|
1229
|
+
answeredBy: z.ZodOptional<z.ZodNullable<z.ZodEnum<["human", "machine", "unknown"]>>>;
|
|
1230
|
+
/**
|
|
1231
|
+
* 수신 통화에서 발신자가 번호 표시제한(`*23#` 등)을 걸고 건 통화면 true, 아니면 false.
|
|
1232
|
+
* 번호는 `from` 에 그대로 있다. 발신 통화와 2026-09-29 이전의 수신 통화는 null.
|
|
1233
|
+
*/
|
|
1234
|
+
callerIdRestricted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
1235
|
+
/**
|
|
1236
|
+
* 통화 종료 사유. status 가 왜 그렇게 끝났는지를 구분한다 — 특히 failed 는 결번·망 오류·
|
|
1237
|
+
* 시스템 오류를 모두 포함하는 대분류라, 발신 리스트를 정제하려면 status 가 아니라 이 값을 본다.
|
|
1238
|
+
*
|
|
1239
|
+
* 재시도해도 소용없음: invalid_number(결번) / number_changed / incompatible_destination.
|
|
1240
|
+
* 재시도 가치 있음: no_answer / user_busy / temporary_failure / switching_congestion /
|
|
1241
|
+
* no_circuit_available / network_out_of_order / destination_out_of_order /
|
|
1242
|
+
* recovery_on_timer_expire / resource_unavailable.
|
|
1243
|
+
* 그 외: normal_clearing(정상 종료) / caller_canceled / call_rejected / protocol_error /
|
|
1244
|
+
* unspecified / app_error·call_stuck(ClawOps 측 오류 — 재시도 권장) / unknown.
|
|
1245
|
+
*
|
|
1246
|
+
* enum 으로 좁히지 않는다 — 통신망이 새 cause 를 보내면 서버가 값을 넓히는데, 그때마다
|
|
1247
|
+
* SDK 릴리즈를 기다려야 파싱되는 구조는 안 된다.
|
|
1248
|
+
*/
|
|
1249
|
+
hangupCause: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1250
|
+
/** 통신망 Q.850 cause code. 1·5·28=결번, 16=정상해제, 17=통화중, 19=무응답, 38=망장애. */
|
|
1251
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1252
|
+
/**
|
|
1253
|
+
* 종료를 유발한 SIP 응답코드(404=없는 번호, 486=통화중, 500=망 오류 등).
|
|
1254
|
+
* 국내 통신망은 실제 사유를 500 으로 감싸 보내기도 하므로 hangupCause 가 더 정확하다.
|
|
1255
|
+
*/
|
|
1256
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1257
|
+
/**
|
|
1258
|
+
* 종료 책임 주체. carrier(통신망) / callee(수신자) / caller(발신자) /
|
|
1259
|
+
* app·system(ClawOps 측 오류 — 수신자 번호를 정제 대상에 넣지 말고 재시도할 것).
|
|
1260
|
+
*/
|
|
1261
|
+
hangupSource: z.ZodOptional<z.ZodNullable<z.ZodEnum<["carrier", "callee", "caller", "app", "system"]>>>;
|
|
1262
|
+
/**
|
|
1263
|
+
* 전환(담당자 연결) 요약 — 이 통화의 **대표 시도** 하나에서 나온 값이다. 대표는 **끝난 시도**
|
|
1264
|
+
* (completed / failed / busy / no-answer / canceled) 중 completed 우선, 같으면 마지막 시도다.
|
|
1265
|
+
*
|
|
1266
|
+
* ⚠️ null 이 「전환이 없었다」를 뜻하지 않는다 — 시도가 아직 진행 중이거나 `interrupted` 로만 끝났어도
|
|
1267
|
+
* null 이다. 전환 여부는 `transfers` 로 판정할 것.
|
|
1268
|
+
*/
|
|
1269
|
+
transferTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1270
|
+
transferStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1271
|
+
/** 연결→종료 초(관측값, 과금 초 아님). 연결되지 못했으면 null. */
|
|
1272
|
+
transferDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1273
|
+
transferHangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1274
|
+
transferSipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1275
|
+
/**
|
|
1276
|
+
* 통신망 원본 진단 텍스트. ⚠️ 위 대표 시도가 아니라 **마지막으로 기록된** 통신망 사유라, 여러 번
|
|
1277
|
+
* 시도한 통화에서는 다른 시도의 것일 수 있다(대표 시도는 completed 인데 이 값은 실패 사유인 경우).
|
|
1278
|
+
* 시도별 사유는 `transfers[].reasonText` 를 쓴다.
|
|
1279
|
+
*/
|
|
1280
|
+
transferReasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1281
|
+
/**
|
|
1282
|
+
* 전환 시도 전체(sequence 순). **단건 조회(`calls.get`)에만** 있고 그 밖의 응답(목록·생성·수정)에는 없다.
|
|
1283
|
+
*
|
|
1284
|
+
* 타입은 `TransferLeg` 지만 런타임에서는 항목이 객체인지만 본다 — 이 타입이 생기기 전에는 passthrough 로
|
|
1285
|
+
* 받았으므로, 시도 하나의 값 타입이 어긋났다고 `calls.get` 전체가 검증 오류로 실패하면 회귀다.
|
|
1286
|
+
*/
|
|
1287
|
+
transfers: z.ZodOptional<z.ZodArray<z.ZodType<z.objectOutputType<{
|
|
1288
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
1289
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1290
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1291
|
+
/** blind / warm / refer / refer-attended. */
|
|
1292
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1293
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
1294
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1295
|
+
/**
|
|
1296
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
1297
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
1298
|
+
*/
|
|
1299
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1300
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
1301
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1302
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
1303
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
1304
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1305
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1306
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1307
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
1308
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1309
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1310
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1311
|
+
/**
|
|
1312
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1313
|
+
*
|
|
1314
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1315
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1316
|
+
*/
|
|
1317
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1318
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1319
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1320
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1321
|
+
/**
|
|
1322
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1323
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1324
|
+
*/
|
|
1325
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1326
|
+
}, z.ZodTypeAny, "passthrough">, z.ZodTypeDef, z.objectOutputType<{
|
|
1327
|
+
/** 이 통화에서 몇 번째 시도인지(1부터). 전환 웹훅의 `TransferSequence` 와 같은 값. */
|
|
1328
|
+
sequence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1329
|
+
to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1330
|
+
/** blind / warm / refer / refer-attended. */
|
|
1331
|
+
mode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1332
|
+
/** pstn / sip. 2026-07-10 이전 전환은 null. */
|
|
1333
|
+
destinationType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1334
|
+
/**
|
|
1335
|
+
* initiated / ringing / connected / completed / failed / no-answer / busy / canceled / interrupted.
|
|
1336
|
+
* enum 으로 좁히지 않는다 — 서버가 값을 넓힐 때 SDK 릴리스를 기다리지 않게(hangupCause 와 같은 이유).
|
|
1337
|
+
*/
|
|
1338
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1339
|
+
/** 연결→종료 초(관측값). 과금 초는 billableDuration. 연결되지 못했으면 null. */
|
|
1340
|
+
duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1341
|
+
/** 과금 대상 여부. 한 통화에서 최대 한 건만 true. */
|
|
1342
|
+
billable: z.ZodOptional<z.ZodBoolean>;
|
|
1343
|
+
billableDuration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1344
|
+
hangupCauseQ850: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1345
|
+
sipResponseCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1346
|
+
/** 통신망 원본 진단 텍스트(자유 형식 — 분기 조건으로 쓰지 말 것). */
|
|
1347
|
+
reasonText: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1348
|
+
/** 시도를 시작한 시각(ISO 8601). 2026-07-10 이전 전환은 null. */
|
|
1349
|
+
startedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1350
|
+
/**
|
|
1351
|
+
* 대상이 전화를 받은 시각. 연결 전 안내 도중 끝나도 남는다.
|
|
1352
|
+
*
|
|
1353
|
+
* 받았는지 판정: **값이 있으면 받은 것이다** — 안내 도중 끝난 warm 전환은 status 가 `failed` 지만
|
|
1354
|
+
* 받은 전환이다. 2026-10-13 이전 전환은 받았어도 null 이라, 그 구간만 status 로 판정한다.
|
|
1355
|
+
*/
|
|
1356
|
+
answeredAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1357
|
+
/** 발신자와 대상이 연결된 시각(안내가 있으면 안내가 끝난 뒤). 연결되지 못했으면 null. */
|
|
1358
|
+
connectedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1359
|
+
endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1360
|
+
/**
|
|
1361
|
+
* 이 시도에 적용한 대기 한도(초). 2026-10-13 이전 전환은 null. `refer-attended` 는 이미 연결된
|
|
1362
|
+
* 상담 통화로 넘겨 기다리는 단계가 없으므로 항상 null 이다.
|
|
1363
|
+
*/
|
|
1364
|
+
timeout: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1365
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1366
|
+
accountId: z.ZodString;
|
|
1367
|
+
dateCreated: z.ZodString;
|
|
1368
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1369
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1370
|
+
type Call = z.infer<typeof CallSchema>;
|
|
1371
|
+
declare const CallControlResponseSchema: z.ZodObject<{
|
|
1372
|
+
callId: z.ZodString;
|
|
1373
|
+
status: z.ZodString;
|
|
1374
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1375
|
+
callId: z.ZodString;
|
|
1376
|
+
status: z.ZodString;
|
|
1377
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1378
|
+
callId: z.ZodString;
|
|
1379
|
+
status: z.ZodString;
|
|
1380
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1381
|
+
type CallControlResponse = z.infer<typeof CallControlResponseSchema>;
|
|
1382
|
+
|
|
1383
|
+
/**
|
|
1384
|
+
* `agentId` 에이전트의 **이번 통화에만** 적용되는 컨텍스트.
|
|
1385
|
+
*
|
|
1386
|
+
* 에이전트 자체의 설정은 그대로 두고 이 통화만 다르게 행동시킬 때 사용한다.
|
|
1387
|
+
* 같은 에이전트로 동시에 거는 다른 통화에는 영향이 없다.
|
|
1388
|
+
*/
|
|
1389
|
+
interface CallContextParam {
|
|
1390
|
+
/** 이번 통화에서 수행할 실행 요구사항 (최대 4000자). */
|
|
1391
|
+
instruction: string;
|
|
1392
|
+
/** 요구사항에서 참조할 통화별 구조화 데이터 (최대 50개). */
|
|
1393
|
+
variables?: Record<string, string | number | boolean>;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* 발신 전화 생성 요청 파라미터.
|
|
1397
|
+
*
|
|
1398
|
+
* **4가지 모드** — `url`, `agentId`, `callFlowId` 는 서로 배타적이다.
|
|
1399
|
+
*
|
|
1400
|
+
* - **VoiceML 모드**: `url` 을 지정하면 VoiceML 로 통화를 제어한다.
|
|
1401
|
+
* - **매니지드 에이전트 모드**: `agentId` 를 지정하면 콘솔에서 만든 AI 에이전트가
|
|
1402
|
+
* 통화를 처리한다. `callContext` 로 이번 통화만의 지시를 덧붙일 수 있다.
|
|
1403
|
+
* - **콜 플로우 모드**: `callFlowId` 를 지정하면 결정적 ARS 플로우가 진행한다.
|
|
1404
|
+
* `variables` 로 시작 변수를 넘긴다.
|
|
1405
|
+
* - **Agent SDK 모드**: 셋 다 생략하면 From 번호에 연결된 Agent SDK 로 연결된다.
|
|
1406
|
+
*/
|
|
1407
|
+
interface CallCreateParams {
|
|
1408
|
+
to: string;
|
|
1409
|
+
from: string;
|
|
1410
|
+
/** VoiceML 명령을 반환할 URL. `agentId`·`callFlowId` 와 배타. */
|
|
1411
|
+
url?: string;
|
|
1412
|
+
/** 콘솔에서 만든 매니지드 에이전트 ID. `url`·`callFlowId` 와 배타. */
|
|
1413
|
+
agentId?: string;
|
|
1414
|
+
/** `agentId` 에이전트의 이번 통화에만 적용되는 컨텍스트. */
|
|
1415
|
+
callContext?: CallContextParam;
|
|
1416
|
+
/** 콜 플로우(결정적 ARS) ID. `url`·`agentId` 와 배타. */
|
|
1417
|
+
callFlowId?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* 콜 플로우 시작 변수. 멘트·URL·본문의 `{{이름}}` 이 이 값으로 치환된다.
|
|
1420
|
+
* `callFlowId` 와 함께일 때만 쓸 수 있다(단독 지정 시 400).
|
|
1421
|
+
* `caller`·`callee`·`recording_url`·`recording_duration`·`http_status` 는
|
|
1422
|
+
* 통화 중 자동으로 채워지는 예약 변수라 지정할 수 없다.
|
|
1423
|
+
*/
|
|
1424
|
+
variables?: Record<string, string | number | boolean>;
|
|
1425
|
+
statusCallback?: string;
|
|
1426
|
+
statusCallbackEvent?: string;
|
|
1427
|
+
/** 발신 타임아웃 (초). 기본값: 60. */
|
|
1428
|
+
timeout?: number;
|
|
1429
|
+
/**
|
|
1430
|
+
* 자동응답기/음성사서함 감지(AMD). `'Enable'`=감지 후 `AnsweredBy` 통보(통화 계속),
|
|
1431
|
+
* `'Hangup'`=음성사서함 감지 시 자동 종료. 미설정 시 비활성.
|
|
1432
|
+
*/
|
|
1433
|
+
machineDetection?: 'Enable' | 'Hangup';
|
|
1434
|
+
}
|
|
1435
|
+
interface CallListParams {
|
|
1436
|
+
status?: 'queued' | 'ringing' | 'in-progress' | 'completed' | 'failed';
|
|
1437
|
+
/** 발신번호로 필터링. 배열 시 IN 조건. */
|
|
1438
|
+
from?: string | string[];
|
|
1439
|
+
/** 수신번호로 필터링. 배열 시 IN 조건. */
|
|
1440
|
+
to?: string | string[];
|
|
1441
|
+
/** 관여 번호로 필터링 (from OR to 매칭). 배열 시 IN 조건. */
|
|
1442
|
+
number?: string | string[];
|
|
1443
|
+
page?: number;
|
|
1444
|
+
pageSize?: number;
|
|
1445
|
+
}
|
|
1446
|
+
interface CallUpdateParams {
|
|
1447
|
+
status?: 'completed';
|
|
1448
|
+
}
|
|
1449
|
+
|
|
1450
|
+
/**
|
|
1451
|
+
* 화자 식별자. **2026-08 이후 전사는 `speaker_0`·`speaker_1`… 형식**이고, 전환 통화처럼
|
|
1452
|
+
* 참여자가 셋 이상이면 그만큼 늘어난다. 그 이전 전사에는 `AGENT`·`CUSTOMER` 가 그대로
|
|
1453
|
+
* 남아 있으므로 **두 형식을 모두 받아야 한다.** 화자와 역할의 연결은 보장되지 않는다.
|
|
1454
|
+
*/
|
|
1455
|
+
type TranscriptSpeaker = 'CUSTOMER' | 'AGENT' | (string & {});
|
|
1456
|
+
/** 전사 실패 단계. `trigger` 는 시스템 실패라 재요청할 수 있다. */
|
|
1457
|
+
type TranscriptStage = 'download' | 'runtime' | 'transcription' | 'trigger' | 'recover' | (string & {});
|
|
1458
|
+
/**
|
|
1459
|
+
* 통화 전사 상태. status 에 따라 채워지는 필드가 다름:
|
|
1460
|
+
* - "completed": callId, segmentCount, segments
|
|
1461
|
+
* - "pending": startedAt
|
|
1462
|
+
* - "failed": stage, error. stage="trigger" 는 시스템 실패로 재요청 가능
|
|
1463
|
+
* - "not_requested": 이외 필드 비어있음
|
|
1464
|
+
*/
|
|
1465
|
+
declare const TranscriptStatusSchema: z.ZodObject<{
|
|
1466
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1467
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1468
|
+
segmentCount: z.ZodOptional<z.ZodNumber>;
|
|
1469
|
+
segments: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1470
|
+
/**
|
|
1471
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1472
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1473
|
+
*/
|
|
1474
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1475
|
+
start: z.ZodNumber;
|
|
1476
|
+
end: z.ZodNumber;
|
|
1477
|
+
text: z.ZodString;
|
|
1478
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1479
|
+
/**
|
|
1480
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1481
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1482
|
+
*/
|
|
1483
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1484
|
+
start: z.ZodNumber;
|
|
1485
|
+
end: z.ZodNumber;
|
|
1486
|
+
text: z.ZodString;
|
|
1487
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1488
|
+
/**
|
|
1489
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1490
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1491
|
+
*/
|
|
1492
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1493
|
+
start: z.ZodNumber;
|
|
1494
|
+
end: z.ZodNumber;
|
|
1495
|
+
text: z.ZodString;
|
|
1496
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1497
|
+
startedAt: z.ZodOptional<z.ZodString>;
|
|
1498
|
+
/**
|
|
1499
|
+
* ⛔ **실패 단계는 서버 코드가 만든다** — 전사 파이프라인이 `download`·`runtime`·
|
|
1500
|
+
* `transcription`·`recover` 를 내보내고, 영구 실패는 예외 객체의 속성을 그대로 싣는다.
|
|
1501
|
+
* 어휘가 열려 있어 스펙의 enum 조차 스냅샷일 뿐이다.
|
|
1502
|
+
*
|
|
1503
|
+
* ⚠️ 여기가 닫혀 있으면 **전사가 실패했을 때 그 이유를 물으면 던진다** — 고객이 가장
|
|
1504
|
+
* 답을 필요로 하는 순간이다.
|
|
1505
|
+
*/
|
|
1506
|
+
stage: z.ZodOptional<z.ZodNullable<z.ZodType<TranscriptStage, z.ZodTypeDef, TranscriptStage>>>;
|
|
1507
|
+
error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1508
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1509
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1510
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1511
|
+
segmentCount: z.ZodOptional<z.ZodNumber>;
|
|
1512
|
+
segments: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1513
|
+
/**
|
|
1514
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1515
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1516
|
+
*/
|
|
1517
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1518
|
+
start: z.ZodNumber;
|
|
1519
|
+
end: z.ZodNumber;
|
|
1520
|
+
text: z.ZodString;
|
|
1521
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1522
|
+
/**
|
|
1523
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1524
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1525
|
+
*/
|
|
1526
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1527
|
+
start: z.ZodNumber;
|
|
1528
|
+
end: z.ZodNumber;
|
|
1529
|
+
text: z.ZodString;
|
|
1530
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1531
|
+
/**
|
|
1532
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1533
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1534
|
+
*/
|
|
1535
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1536
|
+
start: z.ZodNumber;
|
|
1537
|
+
end: z.ZodNumber;
|
|
1538
|
+
text: z.ZodString;
|
|
1539
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1540
|
+
startedAt: z.ZodOptional<z.ZodString>;
|
|
1541
|
+
/**
|
|
1542
|
+
* ⛔ **실패 단계는 서버 코드가 만든다** — 전사 파이프라인이 `download`·`runtime`·
|
|
1543
|
+
* `transcription`·`recover` 를 내보내고, 영구 실패는 예외 객체의 속성을 그대로 싣는다.
|
|
1544
|
+
* 어휘가 열려 있어 스펙의 enum 조차 스냅샷일 뿐이다.
|
|
1545
|
+
*
|
|
1546
|
+
* ⚠️ 여기가 닫혀 있으면 **전사가 실패했을 때 그 이유를 물으면 던진다** — 고객이 가장
|
|
1547
|
+
* 답을 필요로 하는 순간이다.
|
|
1548
|
+
*/
|
|
1549
|
+
stage: z.ZodOptional<z.ZodNullable<z.ZodType<TranscriptStage, z.ZodTypeDef, TranscriptStage>>>;
|
|
1550
|
+
error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1551
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1552
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1553
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1554
|
+
segmentCount: z.ZodOptional<z.ZodNumber>;
|
|
1555
|
+
segments: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1556
|
+
/**
|
|
1557
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1558
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1559
|
+
*/
|
|
1560
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1561
|
+
start: z.ZodNumber;
|
|
1562
|
+
end: z.ZodNumber;
|
|
1563
|
+
text: z.ZodString;
|
|
1564
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1565
|
+
/**
|
|
1566
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1567
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1568
|
+
*/
|
|
1569
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1570
|
+
start: z.ZodNumber;
|
|
1571
|
+
end: z.ZodNumber;
|
|
1572
|
+
text: z.ZodString;
|
|
1573
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1574
|
+
/**
|
|
1575
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 서버는 이미 `speaker_0` 을 보내고 있고, 세그먼트
|
|
1576
|
+
* 하나가 어긋나면 `segments` 배열 때문에 **전사 응답 전체**가 실패한다.
|
|
1577
|
+
*/
|
|
1578
|
+
speaker: z.ZodType<TranscriptSpeaker>;
|
|
1579
|
+
start: z.ZodNumber;
|
|
1580
|
+
end: z.ZodNumber;
|
|
1581
|
+
text: z.ZodString;
|
|
1582
|
+
}, z.ZodTypeAny, "passthrough">>, "many">>;
|
|
1583
|
+
startedAt: z.ZodOptional<z.ZodString>;
|
|
1584
|
+
/**
|
|
1585
|
+
* ⛔ **실패 단계는 서버 코드가 만든다** — 전사 파이프라인이 `download`·`runtime`·
|
|
1586
|
+
* `transcription`·`recover` 를 내보내고, 영구 실패는 예외 객체의 속성을 그대로 싣는다.
|
|
1587
|
+
* 어휘가 열려 있어 스펙의 enum 조차 스냅샷일 뿐이다.
|
|
1588
|
+
*
|
|
1589
|
+
* ⚠️ 여기가 닫혀 있으면 **전사가 실패했을 때 그 이유를 물으면 던진다** — 고객이 가장
|
|
1590
|
+
* 답을 필요로 하는 순간이다.
|
|
1591
|
+
*/
|
|
1592
|
+
stage: z.ZodOptional<z.ZodNullable<z.ZodType<TranscriptStage, z.ZodTypeDef, TranscriptStage>>>;
|
|
1593
|
+
error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1594
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1595
|
+
type TranscriptStatus = z.infer<typeof TranscriptStatusSchema>;
|
|
1596
|
+
/** POST 요청이 accept 되어 Job 이 트리거된 상태 (202). */
|
|
1597
|
+
declare const TranscriptRequestAcceptedSchema: z.ZodObject<{
|
|
1598
|
+
status: z.ZodLiteral<"pending">;
|
|
1599
|
+
callId: z.ZodString;
|
|
1600
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1601
|
+
status: z.ZodLiteral<"pending">;
|
|
1602
|
+
callId: z.ZodString;
|
|
1603
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1604
|
+
status: z.ZodLiteral<"pending">;
|
|
1605
|
+
callId: z.ZodString;
|
|
1606
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1607
|
+
type TranscriptRequestAccepted = z.infer<typeof TranscriptRequestAcceptedSchema>;
|
|
1608
|
+
|
|
1609
|
+
/**
|
|
1610
|
+
* 통화 요약 상태. status 에 따라 채워지는 필드가 다름:
|
|
1611
|
+
* - "completed": callId, resultJson, provider, model, promptVersion, schemaVersion, updatedAt
|
|
1612
|
+
* - "pending": 이외 필드 비어있음
|
|
1613
|
+
* - "failed": failedReason
|
|
1614
|
+
* - "not_requested": 통화는 있지만 요약 row 가 아직 없음
|
|
1615
|
+
*/
|
|
1616
|
+
declare const SummaryStatusSchema: z.ZodObject<{
|
|
1617
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1618
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1619
|
+
resultJson: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
1620
|
+
provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1621
|
+
model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1622
|
+
promptVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1623
|
+
schemaVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1624
|
+
failedReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1625
|
+
updatedAt: z.ZodOptional<z.ZodString>;
|
|
1626
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1627
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1628
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1629
|
+
resultJson: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
1630
|
+
provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1631
|
+
model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1632
|
+
promptVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1633
|
+
schemaVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1634
|
+
failedReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1635
|
+
updatedAt: z.ZodOptional<z.ZodString>;
|
|
1636
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1637
|
+
status: z.ZodEnum<["completed", "pending", "failed", "not_requested"]>;
|
|
1638
|
+
callId: z.ZodOptional<z.ZodString>;
|
|
1639
|
+
resultJson: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
1640
|
+
provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1641
|
+
model: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1642
|
+
promptVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1643
|
+
schemaVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1644
|
+
failedReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1645
|
+
updatedAt: z.ZodOptional<z.ZodString>;
|
|
1646
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1647
|
+
type SummaryStatus = z.infer<typeof SummaryStatusSchema>;
|
|
1648
|
+
|
|
1649
|
+
declare class Calls extends APIResource {
|
|
1650
|
+
create(params: CallCreateParams, options?: {
|
|
1651
|
+
extraHeaders?: Record<string, string>;
|
|
1652
|
+
extraQuery?: Record<string, unknown>;
|
|
1653
|
+
timeout?: number;
|
|
1654
|
+
}): Promise<Call>;
|
|
1655
|
+
list(params?: CallListParams, options?: {
|
|
1656
|
+
extraHeaders?: Record<string, string>;
|
|
1657
|
+
extraQuery?: Record<string, unknown>;
|
|
1658
|
+
timeout?: number;
|
|
1659
|
+
}): Promise<Page<Call>>;
|
|
1660
|
+
get(callId: string, options?: {
|
|
1661
|
+
extraHeaders?: Record<string, string>;
|
|
1662
|
+
extraQuery?: Record<string, unknown>;
|
|
1663
|
+
timeout?: number;
|
|
1664
|
+
}): Promise<Call>;
|
|
1665
|
+
update(callId: string, params?: {
|
|
1666
|
+
status?: 'completed';
|
|
1667
|
+
}, options?: {
|
|
1668
|
+
extraHeaders?: Record<string, string>;
|
|
1669
|
+
extraQuery?: Record<string, unknown>;
|
|
1670
|
+
timeout?: number;
|
|
1671
|
+
}): Promise<CallControlResponse>;
|
|
1672
|
+
/**
|
|
1673
|
+
* 통화 전사 상태 조회. 완료된 경우 segment 배열까지 한 번에 반환합니다.
|
|
1674
|
+
*
|
|
1675
|
+
* @throws NotFoundError (404) — 통화 없음
|
|
1676
|
+
* @throws PermissionDeniedError (403) — accountId 불일치
|
|
1677
|
+
*/
|
|
1678
|
+
getTranscript(callId: string, options?: {
|
|
1679
|
+
extraHeaders?: Record<string, string>;
|
|
1680
|
+
extraQuery?: Record<string, unknown>;
|
|
1681
|
+
timeout?: number;
|
|
1682
|
+
}): Promise<TranscriptStatus>;
|
|
1683
|
+
/**
|
|
1684
|
+
* 특정 통화 1 건에 대해 전사를 명시 요청.
|
|
1685
|
+
* 조직 설정 "통화 받아쓰기" 가 꺼져 있어도 해당 통화만 전사됩니다.
|
|
1686
|
+
* 재실행 금지 — 이미 요청된 통화는 ConflictError(409) 발생.
|
|
1687
|
+
* 시스템 레벨 트리거 실패(stage=trigger) 만 재시도 가능.
|
|
1688
|
+
* 전사된 오디오 길이만큼 사용량 기반으로 과금됩니다.
|
|
1689
|
+
*
|
|
1690
|
+
* @throws BadRequestError (400) — 녹음 없음
|
|
1691
|
+
* @throws NotFoundError (404) — 통화 없음
|
|
1692
|
+
* @throws PermissionDeniedError (403) — accountId 불일치
|
|
1693
|
+
* @throws ConflictError (409) — 이미 요청됨
|
|
1694
|
+
*/
|
|
1695
|
+
requestTranscript(callId: string, options?: {
|
|
1696
|
+
extraHeaders?: Record<string, string>;
|
|
1697
|
+
extraQuery?: Record<string, unknown>;
|
|
1698
|
+
timeout?: number;
|
|
1699
|
+
}): Promise<TranscriptRequestAccepted>;
|
|
1700
|
+
/**
|
|
1701
|
+
* 통화 요약 상태 조회. transcript 가 완료된 통화에 대해 자동 생성된
|
|
1702
|
+
* LLM 구조화 요약 결과를 반환합니다. completed 일 때 resultJson 채워짐.
|
|
1703
|
+
*
|
|
1704
|
+
* @throws NotFoundError (404) — 통화 없음
|
|
1705
|
+
* @throws PermissionDeniedError (403) — accountId 불일치
|
|
1706
|
+
*/
|
|
1707
|
+
getSummary(callId: string, options?: {
|
|
1708
|
+
extraHeaders?: Record<string, string>;
|
|
1709
|
+
extraQuery?: Record<string, unknown>;
|
|
1710
|
+
timeout?: number;
|
|
1711
|
+
}): Promise<SummaryStatus>;
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
/**
|
|
1715
|
+
* 채널 연결 상태. 서버가 어휘를 소유하므로 **열린 유니온**이다 — 목록에 없는 값도 그대로
|
|
1716
|
+
* 실리고, 낡는 것은 자동완성뿐이다.
|
|
1717
|
+
*/
|
|
1718
|
+
type KakaoChannelStatus = 'connected' | 'needs_attention' | (string & {});
|
|
1719
|
+
/**
|
|
1720
|
+
* 이 계정에 연결된 카카오 비즈니스 채널.
|
|
1721
|
+
*
|
|
1722
|
+
* ⚠️ `searchId` 는 채널 소유자가 카카오 비즈니스에서 바꿀 수 있다. **연동 키로 쓰지 말 것** —
|
|
1723
|
+
* 키는 `id`(ClawOps 리소스 ID)다.
|
|
1724
|
+
*/
|
|
1725
|
+
declare const KakaoChannelSchema: z.ZodObject<{
|
|
1726
|
+
/** ClawOps 채널 리소스 ID. 템플릿 조회와 알림톡 발송에 이 값을 쓴다. */
|
|
1727
|
+
id: z.ZodString;
|
|
1728
|
+
/** 카카오 채널 검색용 ID. `@` 없는 형태로 저장된다. */
|
|
1729
|
+
searchId: z.ZodString;
|
|
1730
|
+
name: z.ZodString;
|
|
1731
|
+
categoryCode: z.ZodString;
|
|
1732
|
+
/**
|
|
1733
|
+
* `connected` = 연결 완료. `needs_attention` = 연결 기록은 있으나 카카오 채널 상태를
|
|
1734
|
+
* 확인하지 못한 상태다 — 실제로 끊겼을 수도, 일시적인 조회 실패일 수도 있다.
|
|
1735
|
+
* `channels.retrieve()` 를 다시 부르면 재확인한다.
|
|
1736
|
+
*
|
|
1737
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 상태가 하나 늘면
|
|
1738
|
+
* 닫힌 enum 은 조회를 통째로 실패시킨다(알림톡 `'ata'` 가 정확히 그렇게 터졌다).
|
|
1739
|
+
* 열린 유니온이면 자동완성만 낡고 조회는 계속 산다.
|
|
1740
|
+
*/
|
|
1741
|
+
status: z.ZodType<KakaoChannelStatus>;
|
|
1742
|
+
/** 담당자 휴대전화번호(마스킹). 원문은 저장하지 않는다. */
|
|
1743
|
+
managerPhoneMasked: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1744
|
+
connectedAt: z.ZodString;
|
|
1745
|
+
/** 카카오 채널 상태를 마지막으로 확인한 시각. null 이면 연결 이후 한 번도 확인하지 않았다. */
|
|
1746
|
+
syncedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1747
|
+
createdAt: z.ZodString;
|
|
1748
|
+
updatedAt: z.ZodString;
|
|
1749
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1750
|
+
/** ClawOps 채널 리소스 ID. 템플릿 조회와 알림톡 발송에 이 값을 쓴다. */
|
|
1751
|
+
id: z.ZodString;
|
|
1752
|
+
/** 카카오 채널 검색용 ID. `@` 없는 형태로 저장된다. */
|
|
1753
|
+
searchId: z.ZodString;
|
|
1754
|
+
name: z.ZodString;
|
|
1755
|
+
categoryCode: z.ZodString;
|
|
1756
|
+
/**
|
|
1757
|
+
* `connected` = 연결 완료. `needs_attention` = 연결 기록은 있으나 카카오 채널 상태를
|
|
1758
|
+
* 확인하지 못한 상태다 — 실제로 끊겼을 수도, 일시적인 조회 실패일 수도 있다.
|
|
1759
|
+
* `channels.retrieve()` 를 다시 부르면 재확인한다.
|
|
1760
|
+
*
|
|
1761
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 상태가 하나 늘면
|
|
1762
|
+
* 닫힌 enum 은 조회를 통째로 실패시킨다(알림톡 `'ata'` 가 정확히 그렇게 터졌다).
|
|
1763
|
+
* 열린 유니온이면 자동완성만 낡고 조회는 계속 산다.
|
|
1764
|
+
*/
|
|
1765
|
+
status: z.ZodType<KakaoChannelStatus>;
|
|
1766
|
+
/** 담당자 휴대전화번호(마스킹). 원문은 저장하지 않는다. */
|
|
1767
|
+
managerPhoneMasked: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1768
|
+
connectedAt: z.ZodString;
|
|
1769
|
+
/** 카카오 채널 상태를 마지막으로 확인한 시각. null 이면 연결 이후 한 번도 확인하지 않았다. */
|
|
1770
|
+
syncedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1771
|
+
createdAt: z.ZodString;
|
|
1772
|
+
updatedAt: z.ZodString;
|
|
1773
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1774
|
+
/** ClawOps 채널 리소스 ID. 템플릿 조회와 알림톡 발송에 이 값을 쓴다. */
|
|
1775
|
+
id: z.ZodString;
|
|
1776
|
+
/** 카카오 채널 검색용 ID. `@` 없는 형태로 저장된다. */
|
|
1777
|
+
searchId: z.ZodString;
|
|
1778
|
+
name: z.ZodString;
|
|
1779
|
+
categoryCode: z.ZodString;
|
|
1780
|
+
/**
|
|
1781
|
+
* `connected` = 연결 완료. `needs_attention` = 연결 기록은 있으나 카카오 채널 상태를
|
|
1782
|
+
* 확인하지 못한 상태다 — 실제로 끊겼을 수도, 일시적인 조회 실패일 수도 있다.
|
|
1783
|
+
* `channels.retrieve()` 를 다시 부르면 재확인한다.
|
|
1784
|
+
*
|
|
1785
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 상태가 하나 늘면
|
|
1786
|
+
* 닫힌 enum 은 조회를 통째로 실패시킨다(알림톡 `'ata'` 가 정확히 그렇게 터졌다).
|
|
1787
|
+
* 열린 유니온이면 자동완성만 낡고 조회는 계속 산다.
|
|
1788
|
+
*/
|
|
1789
|
+
status: z.ZodType<KakaoChannelStatus>;
|
|
1790
|
+
/** 담당자 휴대전화번호(마스킹). 원문은 저장하지 않는다. */
|
|
1791
|
+
managerPhoneMasked: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1792
|
+
connectedAt: z.ZodString;
|
|
1793
|
+
/** 카카오 채널 상태를 마지막으로 확인한 시각. null 이면 연결 이후 한 번도 확인하지 않았다. */
|
|
1794
|
+
syncedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1795
|
+
createdAt: z.ZodString;
|
|
1796
|
+
updatedAt: z.ZodString;
|
|
1797
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1798
|
+
type KakaoChannel = z.infer<typeof KakaoChannelSchema>;
|
|
1799
|
+
/**
|
|
1800
|
+
* 알림톡 템플릿.
|
|
1801
|
+
*
|
|
1802
|
+
* 본문·버튼·아이템 리스트·강조 문구는 **카카오 검수를 받은 그대로** 발송된다. 발송 요청으로
|
|
1803
|
+
* 바꿀 수 있는 것은 `variables` 값뿐이다.
|
|
1804
|
+
*/
|
|
1805
|
+
declare const KakaoTemplateSchema: z.ZodObject<{
|
|
1806
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `kakao.templateId` 에 이 값을 쓴다. */
|
|
1807
|
+
id: z.ZodString;
|
|
1808
|
+
/** ClawOps 채널 리소스 ID. 발송의 `kakao.channelId` 와 같은 값이다. */
|
|
1809
|
+
channelId: z.ZodString;
|
|
1810
|
+
name: z.ZodString;
|
|
1811
|
+
/** 검수를 받은 템플릿 본문. `#{변수}` 자리는 발송 시 치환된다. */
|
|
1812
|
+
content: z.ZodString;
|
|
1813
|
+
/**
|
|
1814
|
+
* 카카오 검수 상태(`APPROVED`·`REJECTED` 등). **카카오 쪽 열린 집합이라 문자열이다.**
|
|
1815
|
+
* 발송 가능 여부 판정은 `sendable` 이 정본이다.
|
|
1816
|
+
*/
|
|
1817
|
+
status: z.ZodString;
|
|
1818
|
+
/** 휴면 템플릿. `true` 면 승인 상태여도 발송할 수 없다. */
|
|
1819
|
+
dormant: z.ZodBoolean;
|
|
1820
|
+
/** 지금 발송에 쓸 수 있으면 true. `status === 'APPROVED' && !dormant` 다. */
|
|
1821
|
+
sendable: z.ZodBoolean;
|
|
1822
|
+
/** `CHANNEL`(채널 소유) 또는 `GROUP`(기본 제공). */
|
|
1823
|
+
assignType: z.ZodString;
|
|
1824
|
+
messageType: z.ZodString;
|
|
1825
|
+
emphasizeType: z.ZodString;
|
|
1826
|
+
/**
|
|
1827
|
+
* 발송 시 `kakao.variables` 에 모두 채워야 하는 변수 이름.
|
|
1828
|
+
* 버튼 링크·강조 문구에 들어간 변수도 이 한 목록에 모인다.
|
|
1829
|
+
*/
|
|
1830
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1831
|
+
createdAt: z.ZodString;
|
|
1832
|
+
updatedAt: z.ZodString;
|
|
1833
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1834
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `kakao.templateId` 에 이 값을 쓴다. */
|
|
1835
|
+
id: z.ZodString;
|
|
1836
|
+
/** ClawOps 채널 리소스 ID. 발송의 `kakao.channelId` 와 같은 값이다. */
|
|
1837
|
+
channelId: z.ZodString;
|
|
1838
|
+
name: z.ZodString;
|
|
1839
|
+
/** 검수를 받은 템플릿 본문. `#{변수}` 자리는 발송 시 치환된다. */
|
|
1840
|
+
content: z.ZodString;
|
|
1841
|
+
/**
|
|
1842
|
+
* 카카오 검수 상태(`APPROVED`·`REJECTED` 등). **카카오 쪽 열린 집합이라 문자열이다.**
|
|
1843
|
+
* 발송 가능 여부 판정은 `sendable` 이 정본이다.
|
|
1844
|
+
*/
|
|
1845
|
+
status: z.ZodString;
|
|
1846
|
+
/** 휴면 템플릿. `true` 면 승인 상태여도 발송할 수 없다. */
|
|
1847
|
+
dormant: z.ZodBoolean;
|
|
1848
|
+
/** 지금 발송에 쓸 수 있으면 true. `status === 'APPROVED' && !dormant` 다. */
|
|
1849
|
+
sendable: z.ZodBoolean;
|
|
1850
|
+
/** `CHANNEL`(채널 소유) 또는 `GROUP`(기본 제공). */
|
|
1851
|
+
assignType: z.ZodString;
|
|
1852
|
+
messageType: z.ZodString;
|
|
1853
|
+
emphasizeType: z.ZodString;
|
|
1854
|
+
/**
|
|
1855
|
+
* 발송 시 `kakao.variables` 에 모두 채워야 하는 변수 이름.
|
|
1856
|
+
* 버튼 링크·강조 문구에 들어간 변수도 이 한 목록에 모인다.
|
|
1857
|
+
*/
|
|
1858
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1859
|
+
createdAt: z.ZodString;
|
|
1860
|
+
updatedAt: z.ZodString;
|
|
1861
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1862
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `kakao.templateId` 에 이 값을 쓴다. */
|
|
1863
|
+
id: z.ZodString;
|
|
1864
|
+
/** ClawOps 채널 리소스 ID. 발송의 `kakao.channelId` 와 같은 값이다. */
|
|
1865
|
+
channelId: z.ZodString;
|
|
1866
|
+
name: z.ZodString;
|
|
1867
|
+
/** 검수를 받은 템플릿 본문. `#{변수}` 자리는 발송 시 치환된다. */
|
|
1868
|
+
content: z.ZodString;
|
|
1869
|
+
/**
|
|
1870
|
+
* 카카오 검수 상태(`APPROVED`·`REJECTED` 등). **카카오 쪽 열린 집합이라 문자열이다.**
|
|
1871
|
+
* 발송 가능 여부 판정은 `sendable` 이 정본이다.
|
|
1872
|
+
*/
|
|
1873
|
+
status: z.ZodString;
|
|
1874
|
+
/** 휴면 템플릿. `true` 면 승인 상태여도 발송할 수 없다. */
|
|
1875
|
+
dormant: z.ZodBoolean;
|
|
1876
|
+
/** 지금 발송에 쓸 수 있으면 true. `status === 'APPROVED' && !dormant` 다. */
|
|
1877
|
+
sendable: z.ZodBoolean;
|
|
1878
|
+
/** `CHANNEL`(채널 소유) 또는 `GROUP`(기본 제공). */
|
|
1879
|
+
assignType: z.ZodString;
|
|
1880
|
+
messageType: z.ZodString;
|
|
1881
|
+
emphasizeType: z.ZodString;
|
|
1882
|
+
/**
|
|
1883
|
+
* 발송 시 `kakao.variables` 에 모두 채워야 하는 변수 이름.
|
|
1884
|
+
* 버튼 링크·강조 문구에 들어간 변수도 이 한 목록에 모인다.
|
|
1885
|
+
*/
|
|
1886
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1887
|
+
createdAt: z.ZodString;
|
|
1888
|
+
updatedAt: z.ZodString;
|
|
1889
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1890
|
+
type KakaoTemplate = z.infer<typeof KakaoTemplateSchema>;
|
|
1891
|
+
/**
|
|
1892
|
+
* 브랜드 메시지 말풍선 유형. **이 값이 단가를 정한다** — 텍스트형이 가장 싸고
|
|
1893
|
+
* 와이드리스트·캐러셀·커머스가 가장 비싸다.
|
|
1894
|
+
*
|
|
1895
|
+
* `MessageType` 과 같은 이유로 열어 둔 유니온이다.
|
|
1896
|
+
*/
|
|
1897
|
+
type BrandBubbleType = 'TEXT' | 'IMAGE' | 'WIDE' | 'WIDE_ITEM_LIST' | 'CAROUSEL_FEED' | 'COMMERCE' | 'CAROUSEL_COMMERCE' | (string & {});
|
|
1898
|
+
/**
|
|
1899
|
+
* 브랜드 메시지 템플릿.
|
|
1900
|
+
*
|
|
1901
|
+
* ⭐ **알림톡과 달리 검수가 없다** — `status`·`dormant`·`sendable` 이 없는 이유이고,
|
|
1902
|
+
* 목록에 있으면 곧 발송할 수 있다.
|
|
1903
|
+
*/
|
|
1904
|
+
declare const KakaoBrandTemplateSchema: z.ZodObject<{
|
|
1905
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `brand.templateId` 에 이 값을 쓴다. */
|
|
1906
|
+
id: z.ZodString;
|
|
1907
|
+
/** ClawOps 채널 리소스 ID. 발송의 `brand.channelId` 와 같은 값이다. */
|
|
1908
|
+
channelId: z.ZodString;
|
|
1909
|
+
name: z.ZodString;
|
|
1910
|
+
chatBubbleType: z.ZodType<BrandBubbleType>;
|
|
1911
|
+
/**
|
|
1912
|
+
* 말풍선 본문.
|
|
1913
|
+
*
|
|
1914
|
+
* ⚠️ **유형에 따라 `null` 이다.** 본문이 담기는 자리가 유형마다 달라 `TEXT`·`IMAGE`·
|
|
1915
|
+
* `WIDE` 에만 채워진다 — 나머지는 헤더·카드·상품명이 그 자리를 대신한다.
|
|
1916
|
+
*/
|
|
1917
|
+
content: z.ZodNullable<z.ZodString>;
|
|
1918
|
+
/** 와이드리스트형의 머리말. 다른 유형에서는 `null`. */
|
|
1919
|
+
header: z.ZodNullable<z.ZodString>;
|
|
1920
|
+
/** 발송 시 `brand.variables` 에 모두 채워야 하는 변수 이름. */
|
|
1921
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1922
|
+
createdAt: z.ZodString;
|
|
1923
|
+
updatedAt: z.ZodString;
|
|
1924
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1925
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `brand.templateId` 에 이 값을 쓴다. */
|
|
1926
|
+
id: z.ZodString;
|
|
1927
|
+
/** ClawOps 채널 리소스 ID. 발송의 `brand.channelId` 와 같은 값이다. */
|
|
1928
|
+
channelId: z.ZodString;
|
|
1929
|
+
name: z.ZodString;
|
|
1930
|
+
chatBubbleType: z.ZodType<BrandBubbleType>;
|
|
1931
|
+
/**
|
|
1932
|
+
* 말풍선 본문.
|
|
1933
|
+
*
|
|
1934
|
+
* ⚠️ **유형에 따라 `null` 이다.** 본문이 담기는 자리가 유형마다 달라 `TEXT`·`IMAGE`·
|
|
1935
|
+
* `WIDE` 에만 채워진다 — 나머지는 헤더·카드·상품명이 그 자리를 대신한다.
|
|
1936
|
+
*/
|
|
1937
|
+
content: z.ZodNullable<z.ZodString>;
|
|
1938
|
+
/** 와이드리스트형의 머리말. 다른 유형에서는 `null`. */
|
|
1939
|
+
header: z.ZodNullable<z.ZodString>;
|
|
1940
|
+
/** 발송 시 `brand.variables` 에 모두 채워야 하는 변수 이름. */
|
|
1941
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1942
|
+
createdAt: z.ZodString;
|
|
1943
|
+
updatedAt: z.ZodString;
|
|
1944
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1945
|
+
/** ClawOps 템플릿 리소스 ID. 발송의 `brand.templateId` 에 이 값을 쓴다. */
|
|
1946
|
+
id: z.ZodString;
|
|
1947
|
+
/** ClawOps 채널 리소스 ID. 발송의 `brand.channelId` 와 같은 값이다. */
|
|
1948
|
+
channelId: z.ZodString;
|
|
1949
|
+
name: z.ZodString;
|
|
1950
|
+
chatBubbleType: z.ZodType<BrandBubbleType>;
|
|
1951
|
+
/**
|
|
1952
|
+
* 말풍선 본문.
|
|
1953
|
+
*
|
|
1954
|
+
* ⚠️ **유형에 따라 `null` 이다.** 본문이 담기는 자리가 유형마다 달라 `TEXT`·`IMAGE`·
|
|
1955
|
+
* `WIDE` 에만 채워진다 — 나머지는 헤더·카드·상품명이 그 자리를 대신한다.
|
|
1956
|
+
*/
|
|
1957
|
+
content: z.ZodNullable<z.ZodString>;
|
|
1958
|
+
/** 와이드리스트형의 머리말. 다른 유형에서는 `null`. */
|
|
1959
|
+
header: z.ZodNullable<z.ZodString>;
|
|
1960
|
+
/** 발송 시 `brand.variables` 에 모두 채워야 하는 변수 이름. */
|
|
1961
|
+
variables: z.ZodArray<z.ZodString, "many">;
|
|
1962
|
+
createdAt: z.ZodString;
|
|
1963
|
+
updatedAt: z.ZodString;
|
|
1964
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
1965
|
+
type KakaoBrandTemplate = z.infer<typeof KakaoBrandTemplateSchema>;
|
|
1966
|
+
/**
|
|
1967
|
+
* 자유형 말풍선에 실을 이미지.
|
|
1968
|
+
*
|
|
1969
|
+
* ⭐ `id` 는 **ClawOps 리소스 ID** 다 — 벤더 파일 식별자가 아니다. 발송의
|
|
1970
|
+
* `brand.free.imageId` 에 이 값을 넣으면 서버가 벤더 값으로 바꿔 보낸다.
|
|
1971
|
+
*/
|
|
1972
|
+
declare const KakaoBrandImageSchema: z.ZodObject<{
|
|
1973
|
+
id: z.ZodString;
|
|
1974
|
+
/** 업로드할 때 지정한 말풍선 유형. 규격이 유형마다 달라 다른 유형엔 재사용할 수 없다. */
|
|
1975
|
+
bubbleType: z.ZodType<BrandBubbleType>;
|
|
1976
|
+
/** `'main'` | `'sub'`. 서브는 와이드리스트형에만 있다(메인 2:1, 서브 1:1). */
|
|
1977
|
+
slot: z.ZodString;
|
|
1978
|
+
/** 업로드한 원본 파일 이름. */
|
|
1979
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1980
|
+
createdAt: z.ZodString;
|
|
1981
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
1982
|
+
id: z.ZodString;
|
|
1983
|
+
/** 업로드할 때 지정한 말풍선 유형. 규격이 유형마다 달라 다른 유형엔 재사용할 수 없다. */
|
|
1984
|
+
bubbleType: z.ZodType<BrandBubbleType>;
|
|
1985
|
+
/** `'main'` | `'sub'`. 서브는 와이드리스트형에만 있다(메인 2:1, 서브 1:1). */
|
|
1986
|
+
slot: z.ZodString;
|
|
1987
|
+
/** 업로드한 원본 파일 이름. */
|
|
1988
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1989
|
+
createdAt: z.ZodString;
|
|
1990
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
1991
|
+
id: z.ZodString;
|
|
1992
|
+
/** 업로드할 때 지정한 말풍선 유형. 규격이 유형마다 달라 다른 유형엔 재사용할 수 없다. */
|
|
1993
|
+
bubbleType: z.ZodType<BrandBubbleType>;
|
|
1994
|
+
/** `'main'` | `'sub'`. 서브는 와이드리스트형에만 있다(메인 2:1, 서브 1:1). */
|
|
1995
|
+
slot: z.ZodString;
|
|
1996
|
+
/** 업로드한 원본 파일 이름. */
|
|
1997
|
+
name: z.ZodNullable<z.ZodString>;
|
|
1998
|
+
createdAt: z.ZodString;
|
|
1999
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2000
|
+
type KakaoBrandImage = z.infer<typeof KakaoBrandImageSchema>;
|
|
2001
|
+
/** 채널 업종 카테고리. **열린 집합이므로 코드에 하드코딩하지 말 것** — 이 응답이 정본이다. */
|
|
2002
|
+
declare const KakaoChannelCategorySchema: z.ZodObject<{
|
|
2003
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2004
|
+
code: z.ZodString;
|
|
2005
|
+
name: z.ZodString;
|
|
2006
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2007
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2008
|
+
code: z.ZodString;
|
|
2009
|
+
name: z.ZodString;
|
|
2010
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2011
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2012
|
+
code: z.ZodString;
|
|
2013
|
+
name: z.ZodString;
|
|
2014
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2015
|
+
type KakaoChannelCategory = z.infer<typeof KakaoChannelCategorySchema>;
|
|
2016
|
+
declare const KakaoChannelCategoryListSchema: z.ZodObject<{
|
|
2017
|
+
data: z.ZodArray<z.ZodObject<{
|
|
2018
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2019
|
+
code: z.ZodString;
|
|
2020
|
+
name: z.ZodString;
|
|
2021
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2022
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2023
|
+
code: z.ZodString;
|
|
2024
|
+
name: z.ZodString;
|
|
2025
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2026
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2027
|
+
code: z.ZodString;
|
|
2028
|
+
name: z.ZodString;
|
|
2029
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
2030
|
+
meta: z.ZodObject<{
|
|
2031
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2032
|
+
fetchedAt: z.ZodString;
|
|
2033
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2034
|
+
cached: z.ZodBoolean;
|
|
2035
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2036
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2037
|
+
fetchedAt: z.ZodString;
|
|
2038
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2039
|
+
cached: z.ZodBoolean;
|
|
2040
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2041
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2042
|
+
fetchedAt: z.ZodString;
|
|
2043
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2044
|
+
cached: z.ZodBoolean;
|
|
2045
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2046
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2047
|
+
data: z.ZodArray<z.ZodObject<{
|
|
2048
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2049
|
+
code: z.ZodString;
|
|
2050
|
+
name: z.ZodString;
|
|
2051
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2052
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2053
|
+
code: z.ZodString;
|
|
2054
|
+
name: z.ZodString;
|
|
2055
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2056
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2057
|
+
code: z.ZodString;
|
|
2058
|
+
name: z.ZodString;
|
|
2059
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
2060
|
+
meta: z.ZodObject<{
|
|
2061
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2062
|
+
fetchedAt: z.ZodString;
|
|
2063
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2064
|
+
cached: z.ZodBoolean;
|
|
2065
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2066
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2067
|
+
fetchedAt: z.ZodString;
|
|
2068
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2069
|
+
cached: z.ZodBoolean;
|
|
2070
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2071
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2072
|
+
fetchedAt: z.ZodString;
|
|
2073
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2074
|
+
cached: z.ZodBoolean;
|
|
2075
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2076
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2077
|
+
data: z.ZodArray<z.ZodObject<{
|
|
2078
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2079
|
+
code: z.ZodString;
|
|
2080
|
+
name: z.ZodString;
|
|
2081
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2082
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2083
|
+
code: z.ZodString;
|
|
2084
|
+
name: z.ZodString;
|
|
2085
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2086
|
+
/** 채널 연결의 `categoryCode` 에 그대로 보내는 값. */
|
|
2087
|
+
code: z.ZodString;
|
|
2088
|
+
name: z.ZodString;
|
|
2089
|
+
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
2090
|
+
meta: z.ZodObject<{
|
|
2091
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2092
|
+
fetchedAt: z.ZodString;
|
|
2093
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2094
|
+
cached: z.ZodBoolean;
|
|
2095
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2096
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2097
|
+
fetchedAt: z.ZodString;
|
|
2098
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2099
|
+
cached: z.ZodBoolean;
|
|
2100
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2101
|
+
/** 이 목록을 공급자에서 실제로 받아 온 시각. */
|
|
2102
|
+
fetchedAt: z.ZodString;
|
|
2103
|
+
/** 서버 캐시에서 응답했는지. 캐시는 짧고 값이 바뀌면 자동으로 따라간다. */
|
|
2104
|
+
cached: z.ZodBoolean;
|
|
2105
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2106
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2107
|
+
type KakaoChannelCategoryList = z.infer<typeof KakaoChannelCategoryListSchema>;
|
|
2108
|
+
/**
|
|
2109
|
+
* 인증번호 발송 요청 접수 결과.
|
|
2110
|
+
*
|
|
2111
|
+
* **응답에 인증번호는 없다.** 인증번호는 카카오 비즈니스에 등록된 담당자 휴대전화로만 가고,
|
|
2112
|
+
* ClawOps 는 그 값을 받지도 저장하지도 않는다.
|
|
2113
|
+
*/
|
|
2114
|
+
declare const KakaoTokenRequestSchema: z.ZodObject<{
|
|
2115
|
+
requested: z.ZodBoolean;
|
|
2116
|
+
/** 정규화된 검색용 ID. `channels.connect()` 에 이 값을 그대로 보낸다. */
|
|
2117
|
+
searchId: z.ZodString;
|
|
2118
|
+
/** 인증번호가 발송된 번호(마스킹). */
|
|
2119
|
+
phoneNumberMasked: z.ZodString;
|
|
2120
|
+
/** 재요청까지 기다릴 시간(초). */
|
|
2121
|
+
retryAfterSeconds: z.ZodNumber;
|
|
2122
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2123
|
+
requested: z.ZodBoolean;
|
|
2124
|
+
/** 정규화된 검색용 ID. `channels.connect()` 에 이 값을 그대로 보낸다. */
|
|
2125
|
+
searchId: z.ZodString;
|
|
2126
|
+
/** 인증번호가 발송된 번호(마스킹). */
|
|
2127
|
+
phoneNumberMasked: z.ZodString;
|
|
2128
|
+
/** 재요청까지 기다릴 시간(초). */
|
|
2129
|
+
retryAfterSeconds: z.ZodNumber;
|
|
2130
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2131
|
+
requested: z.ZodBoolean;
|
|
2132
|
+
/** 정규화된 검색용 ID. `channels.connect()` 에 이 값을 그대로 보낸다. */
|
|
2133
|
+
searchId: z.ZodString;
|
|
2134
|
+
/** 인증번호가 발송된 번호(마스킹). */
|
|
2135
|
+
phoneNumberMasked: z.ZodString;
|
|
2136
|
+
/** 재요청까지 기다릴 시간(초). */
|
|
2137
|
+
retryAfterSeconds: z.ZodNumber;
|
|
2138
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2139
|
+
type KakaoTokenRequest = z.infer<typeof KakaoTokenRequestSchema>;
|
|
2140
|
+
|
|
2141
|
+
interface KakaoChannelListParams {
|
|
2142
|
+
/** 미지정·`'all'` 은 전체. 그 밖의 값은 `400` 이다 — 오타가 조용히 전체 목록이 되지 않는다. */
|
|
2143
|
+
status?: KakaoChannelStatus | 'all';
|
|
2144
|
+
page?: number;
|
|
2145
|
+
pageSize?: number;
|
|
2146
|
+
}
|
|
2147
|
+
interface KakaoTokenRequestParams {
|
|
2148
|
+
/** 카카오 채널 검색용 ID. `@` 를 붙여 보내도 떼어내고 처리한다. */
|
|
2149
|
+
searchId: string;
|
|
2150
|
+
/**
|
|
2151
|
+
* 인증번호를 받을 담당자 휴대전화번호. 하이픈·`+82` 형태 모두 허용된다.
|
|
2152
|
+
* **카카오 비즈니스 채널에 관리자로 등록된 번호여야** 인증번호가 발송된다.
|
|
2153
|
+
*/
|
|
2154
|
+
phoneNumber: string;
|
|
2155
|
+
}
|
|
2156
|
+
interface KakaoChannelConnectParams {
|
|
2157
|
+
/** `channels.requestToken()` 이 돌려준 정규화된 값을 그대로 보낸다. */
|
|
2158
|
+
searchId: string;
|
|
2159
|
+
/** 인증번호를 받은 담당자 휴대전화번호. 앞 단계와 같은 번호여야 한다. */
|
|
2160
|
+
phoneNumber: string;
|
|
2161
|
+
/** `channelCategories()` 응답의 `code`. */
|
|
2162
|
+
categoryCode: string;
|
|
2163
|
+
/** 담당자 휴대전화로 받은 인증번호. 저장하지 않고 확인에만 쓴다. */
|
|
2164
|
+
token: string;
|
|
2165
|
+
}
|
|
2166
|
+
interface KakaoTemplateListParams {
|
|
2167
|
+
/** ClawOps 채널 리소스 ID. **필수다** — 없으면 `400` 이다. */
|
|
2168
|
+
channelId: string;
|
|
2169
|
+
page?: number;
|
|
2170
|
+
pageSize?: number;
|
|
2171
|
+
}
|
|
2172
|
+
/** 브랜드 메시지 템플릿 목록. 알림톡과 같은 축(채널 필수)이다. */
|
|
2173
|
+
interface KakaoBrandTemplateListParams {
|
|
2174
|
+
/** ClawOps 채널 리소스 ID. **필수다** — 없으면 `400` 이다. */
|
|
2175
|
+
channelId: string;
|
|
2176
|
+
page?: number;
|
|
2177
|
+
pageSize?: number;
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2180
|
+
type RequestOptions$1 = {
|
|
2181
|
+
extraHeaders?: Record<string, string>;
|
|
2182
|
+
extraQuery?: Record<string, unknown>;
|
|
2183
|
+
timeout?: number;
|
|
2184
|
+
};
|
|
2185
|
+
/**
|
|
2186
|
+
* 카카오 비즈니스 채널.
|
|
2187
|
+
*
|
|
2188
|
+
* 채널 연결은 두 단계다 — `requestToken()` 으로 담당자 휴대전화에 인증번호를 보내고,
|
|
2189
|
+
* 받은 번호를 `connect()` 에 실어 완료한다. 서버는 그 사이 상태를 저장하지 않으므로
|
|
2190
|
+
* `searchId` 와 `phoneNumber` 를 두 번 모두 보낸다.
|
|
2191
|
+
*/
|
|
2192
|
+
declare class KakaoChannels extends APIResource {
|
|
2193
|
+
private get _path();
|
|
2194
|
+
/**
|
|
2195
|
+
* 연결된 채널 목록.
|
|
2196
|
+
*
|
|
2197
|
+
* **카카오 쪽 상태를 확인하지 않는다** — 저장된 연결 정보를 그대로 돌려주므로 빠르다.
|
|
2198
|
+
* 실제 채널 상태까지 확인하려면 `retrieve()` 를 쓴다.
|
|
2199
|
+
*/
|
|
2200
|
+
list(params?: KakaoChannelListParams, options?: RequestOptions$1): Promise<Page<KakaoChannel>>;
|
|
2201
|
+
/**
|
|
2202
|
+
* 채널 하나를 조회한다. **목록과 달리 카카오 쪽 상태를 실제로 확인하고 `status` 를 갱신한다.**
|
|
2203
|
+
*
|
|
2204
|
+
* `connect()` 가 타임아웃됐을 때 결과를 확정하는 경로이기도 하다 — 연결을 재호출하면 중복
|
|
2205
|
+
* 등록을 시도하게 되지만 이 조회는 몇 번을 불러도 안전하다.
|
|
2206
|
+
*
|
|
2207
|
+
* 카카오 쪽 조회에 실패해도 `404` 가 아니다. 연결 기록은 유효하므로 `status` 가
|
|
2208
|
+
* `needs_attention` 으로 온다.
|
|
2209
|
+
*/
|
|
2210
|
+
retrieve(channelId: string, options?: RequestOptions$1): Promise<KakaoChannel>;
|
|
2211
|
+
/**
|
|
2212
|
+
* 채널 권한을 증명할 인증번호를 **담당자 휴대전화로 발송**해 달라고 요청한다. 연결의 첫 단계다.
|
|
2213
|
+
*
|
|
2214
|
+
* 응답에 인증번호는 없다(`202`). 받은 번호는 `connect()` 의 `token` 으로 보내며, 유효 시간이
|
|
2215
|
+
* 있으므로 받은 뒤 바로 진행한다. 재요청이 잦으면 `429 KAKAO_RATE_LIMITED` 이고
|
|
2216
|
+
* 응답의 `retryAfterSeconds` 만큼 기다린다.
|
|
2217
|
+
*/
|
|
2218
|
+
requestToken(params: KakaoTokenRequestParams, options?: RequestOptions$1): Promise<KakaoTokenRequest>;
|
|
2219
|
+
/**
|
|
2220
|
+
* 인증번호로 채널 연결을 완료한다. **먼저 `requestToken()` 을 불러야 한다.**
|
|
2221
|
+
*
|
|
2222
|
+
* **멱등이다** — 이미 이 계정에 연결된 채널이면 인증번호를 소모하지 않고 기존 연결을 돌려준다.
|
|
2223
|
+
* 다른 계정에 연결된 채널은 멱등이 아니라 충돌이라 `409 KAKAO_CHANNEL_ALREADY_LINKED` 다.
|
|
2224
|
+
*
|
|
2225
|
+
* ⚠️ **타임아웃되면 재호출하지 말 것.** 이미 연결에 성공했을 수 있어 중복 등록을 시도하게 된다.
|
|
2226
|
+
* `list()` 나 `retrieve()` 로 실제 등록 여부를 확인한 뒤 결과를 확정한다.
|
|
2227
|
+
*
|
|
2228
|
+
* ⚠️ **실패해도 인증번호는 소모된다**(`422 KAKAO_TOKEN_INVALID`·`KAKAO_CHANNEL_REJECTED`).
|
|
2229
|
+
* 원인을 해결한 뒤 `requestToken()` 부터 다시 시작해야 한다.
|
|
2230
|
+
*/
|
|
2231
|
+
connect(params: KakaoChannelConnectParams, options?: RequestOptions$1): Promise<KakaoChannel>;
|
|
2232
|
+
/**
|
|
2233
|
+
* 채널 연동을 해제한다. 카카오톡 채널 자체는 지워지지 않고 ClawOps 와의 연동만 끊긴다.
|
|
2234
|
+
*
|
|
2235
|
+
* ⚠️ **되돌릴 수 없고, 그 채널에 등록된 알림톡 템플릿도 함께 삭제된다.** 템플릿은 카카오
|
|
2236
|
+
* 검수를 다시 받아야 하므로 복구에 시간이 걸린다 — 호출 전에 사용자 확인을 받을 것.
|
|
2237
|
+
*
|
|
2238
|
+
* 해제 후에는 그 채널을 다시 연결할 수 있다(본인이든 다른 계정이든). `requestToken()` 부터
|
|
2239
|
+
* 다시 시작하면 된다.
|
|
2240
|
+
*/
|
|
2241
|
+
disconnect(channelId: string, options?: RequestOptions$1): Promise<KakaoChannel>;
|
|
2242
|
+
}
|
|
2243
|
+
/** 알림톡 템플릿(읽기 전용). 등록·검수는 콘솔에서 한다. */
|
|
2244
|
+
declare class KakaoTemplates extends APIResource {
|
|
2245
|
+
/**
|
|
2246
|
+
* 한 채널의 알림톡 템플릿 목록.
|
|
2247
|
+
*
|
|
2248
|
+
* 응답의 `data[].id` 를 발송의 `kakao.templateId` 로, `data[].channelId` 를
|
|
2249
|
+
* `kakao.channelId` 로 쓴다. **`sendable: true` 인 템플릿만 발송할 수 있고**,
|
|
2250
|
+
* `variables` 의 모든 항목을 발송 요청의 `kakao.variables` 에 채워야 한다.
|
|
2251
|
+
*/
|
|
2252
|
+
list(params: KakaoTemplateListParams, options?: RequestOptions$1): Promise<Page<KakaoTemplate>>;
|
|
2253
|
+
}
|
|
2254
|
+
declare class KakaoBrandTemplates extends APIResource {
|
|
2255
|
+
/**
|
|
2256
|
+
* 한 채널의 브랜드 메시지 템플릿 목록.
|
|
2257
|
+
*
|
|
2258
|
+
* 응답의 `data[].id` 를 발송의 `brand.templateId` 로, `data[].channelId` 를
|
|
2259
|
+
* `brand.channelId` 로 쓴다. `variables` 의 모든 항목을 `brand.variables` 에 채워야 한다.
|
|
2260
|
+
*
|
|
2261
|
+
* ⭐ **알림톡과 달리 검수가 없어** `sendable` 같은 칸이 없다 — 목록에 있으면 곧 보낼 수 있다.
|
|
2262
|
+
*/
|
|
2263
|
+
list(params: KakaoBrandTemplateListParams, options?: RequestOptions$1): Promise<Page<KakaoBrandTemplate>>;
|
|
2264
|
+
}
|
|
2265
|
+
/**
|
|
2266
|
+
* 자유형 말풍선에 실을 이미지.
|
|
2267
|
+
*
|
|
2268
|
+
* ⭐ **업로드 한 번, 발송 여러 번.** 캠페인 하나에 수천 건이 같은 그림을 쓰므로 받은 `id` 를
|
|
2269
|
+
* 재사용한다 — 발송마다 다시 올릴 필요가 없다.
|
|
2270
|
+
*
|
|
2271
|
+
* ⚠️ **규격이 말풍선 유형마다 다르다.** 업로드할 때 준 `bubbleType` 과 다른 유형에 쓰면
|
|
2272
|
+
* 카카오가 발송 단계에서 거절한다 — 그 유형으로 다시 올려야 한다.
|
|
2273
|
+
*/
|
|
2274
|
+
declare class KakaoBrandImages extends APIResource {
|
|
2275
|
+
private get _path();
|
|
2276
|
+
/**
|
|
2277
|
+
* 이미지를 올리고 발송에 쓸 `id` 를 받는다.
|
|
2278
|
+
*
|
|
2279
|
+
* ```ts
|
|
2280
|
+
* const image = await client.kakao.brandImages.upload({
|
|
2281
|
+
* file: readFileSync('banner.png'),
|
|
2282
|
+
* filename: 'banner.png',
|
|
2283
|
+
* bubbleType: 'WIDE',
|
|
2284
|
+
* });
|
|
2285
|
+
* await client.messages.create({
|
|
2286
|
+
* to: '01012345678',
|
|
2287
|
+
* from: '07012345678',
|
|
2288
|
+
* brand: {
|
|
2289
|
+
* channelId,
|
|
2290
|
+
* free: { chatBubbleType: 'WIDE', content: '신메뉴가 나왔어요.', imageId: image.id },
|
|
2291
|
+
* },
|
|
2292
|
+
* });
|
|
2293
|
+
* ```
|
|
2294
|
+
*
|
|
2295
|
+
* ⚠️ `TEXT` 는 이미지 자리가 없어 `400` 이다. 자동완성에 뜨지만 쓸 수 없다.
|
|
2296
|
+
*
|
|
2297
|
+
* ⚠️ **상한은 5MB 다.** 넘으면 `400`, 10MB 를 넘으면 업로드 검증기가 먼저 끊어 `413` 이고
|
|
2298
|
+
* **`code` 가 없다** — 즉 "너무 크다" 가 두 모양으로 온다.
|
|
2299
|
+
*
|
|
2300
|
+
* @param params.filename 원본 파일 이름. 목록에서 사람이 알아볼 유일한 단서다.
|
|
2301
|
+
* @param params.slot 와이드리스트형에서 작은 항목에 쓸 이미지면 `'sub'`. 기본은 `'main'`.
|
|
2302
|
+
*/
|
|
2303
|
+
upload(params: {
|
|
2304
|
+
file: Blob | Uint8Array;
|
|
2305
|
+
filename: string;
|
|
2306
|
+
bubbleType: BrandBubbleType;
|
|
2307
|
+
slot?: string;
|
|
2308
|
+
}, options?: RequestOptions$1): Promise<{
|
|
2309
|
+
id: string;
|
|
2310
|
+
}>;
|
|
2311
|
+
/** 올려 둔 이미지 목록. **`id` 를 잃었을 때 되찾는 경로다.** */
|
|
2312
|
+
list(params?: {
|
|
2313
|
+
page?: number;
|
|
2314
|
+
pageSize?: number;
|
|
2315
|
+
}, options?: RequestOptions$1): Promise<Page<KakaoBrandImage>>;
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* 카카오 알림톡·브랜드 메시지 관련 리소스.
|
|
2319
|
+
*
|
|
2320
|
+
* 발송 자체는 `client.messages.create({ kakao: … })` 또는 `({ brand: … })` 다 —
|
|
2321
|
+
* 여기서 얻은 채널·템플릿 ID 를 그대로 쓴다.
|
|
2322
|
+
*/
|
|
2323
|
+
declare class Kakao extends APIResource {
|
|
2324
|
+
get channels(): KakaoChannels;
|
|
2325
|
+
get templates(): KakaoTemplates;
|
|
2326
|
+
/** 브랜드 메시지 템플릿. 알림톡 템플릿(`templates`)과 **다른 표**다. */
|
|
2327
|
+
get brandTemplates(): KakaoBrandTemplates;
|
|
2328
|
+
/** 자유형 말풍선에 실을 이미지. 템플릿형은 이미지가 템플릿에 들어 있어 필요 없다. */
|
|
2329
|
+
get brandImages(): KakaoBrandImages;
|
|
2330
|
+
/**
|
|
2331
|
+
* 채널 연결 시 지정할 업종 카테고리 목록.
|
|
2332
|
+
*
|
|
2333
|
+
* **값을 코드에 하드코딩하지 말 것** — 카카오/공급자 쪽에서 늘거나 바뀌는 열린 집합이고
|
|
2334
|
+
* 이 응답이 그때그때의 정본이다. 응답의 `code` 를 `channels.connect()` 의 `categoryCode`
|
|
2335
|
+
* 로 그대로 보낸다.
|
|
2336
|
+
*
|
|
2337
|
+
* 페이지네이션이 없어 `Page` 가 아니라 `{ data, meta }` 를 그대로 돌려준다.
|
|
2338
|
+
*/
|
|
2339
|
+
channelCategories(options?: RequestOptions$1): Promise<KakaoChannelCategoryList>;
|
|
2340
|
+
}
|
|
2341
|
+
|
|
2342
|
+
/**
|
|
2343
|
+
* 메시지 상태.
|
|
2344
|
+
*
|
|
2345
|
+
* ⚠️ 한때 여기 `'sending'` 이 있었는데 **서버가 한 번도 보낸 적 없는 값**이다 — 어휘를 손으로
|
|
2346
|
+
* 관리하면 없는 값이 들어오고 있는 값이 빠진다. 그래서 이 유니온은 자동완성용이고,
|
|
2347
|
+
* 검증은 하지 않는다.
|
|
2348
|
+
*/
|
|
2349
|
+
type MessageStatus = 'queued' | 'sent' | 'failed' | 'received' | (string & {});
|
|
2350
|
+
/**
|
|
2351
|
+
* 메시지 유형. `KakaoChannelStatus` 와 같은 이유로 **열린 유니온**이다 — 서버가 어휘를
|
|
2352
|
+
* 소유하므로 값이 하나 늘어도 조회는 살아 있어야 하고, 낡는 것은 자동완성뿐이다.
|
|
2353
|
+
*/
|
|
2354
|
+
type MessageType = 'sms' | 'lms' | 'mms'
|
|
2355
|
+
/** 카카오 알림톡. */
|
|
2356
|
+
| 'ata'
|
|
2357
|
+
/** 카카오 브랜드 메시지. */
|
|
2358
|
+
| 'bms' | (string & {});
|
|
2359
|
+
declare const MessageSchema: z.ZodObject<{
|
|
2360
|
+
messageId: z.ZodString;
|
|
2361
|
+
status: z.ZodType<MessageStatus>;
|
|
2362
|
+
/**
|
|
2363
|
+
* `'ata'`(알림톡)·`'bms'`(브랜드 메시지)는 카카오로 나간다. `body` 에는 템플릿에 변수를
|
|
2364
|
+
* 치환한 결과가 담기고, 버튼·아이템 리스트·강조 문구는 템플릿에 담긴 대로 발송되어
|
|
2365
|
+
* 이 값에는 담기지 않는다.
|
|
2366
|
+
*
|
|
2367
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 유형이 하나 늘면 닫힌
|
|
2368
|
+
* enum 은 **목록을 통째로** 실패시킨다(`list()` 는 페이지를 한 번에 파싱한다). 실제로
|
|
2369
|
+
* 두 번 그렇게 터졌다 — `'ata'` 가 나왔을 때, 그리고 `'bms'` 가 나왔을 때.
|
|
2370
|
+
*/
|
|
2371
|
+
type: z.ZodType<MessageType>;
|
|
2372
|
+
to: z.ZodString;
|
|
2373
|
+
from: z.ZodString;
|
|
2374
|
+
body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2375
|
+
subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2376
|
+
numMedia: z.ZodNumber;
|
|
2377
|
+
mediaUrl: z.ZodArray<z.ZodString, "many">;
|
|
2378
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
2379
|
+
accountId: z.ZodString;
|
|
2380
|
+
dateCreated: z.ZodString;
|
|
2381
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2382
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2383
|
+
messageId: z.ZodString;
|
|
2384
|
+
status: z.ZodType<MessageStatus>;
|
|
2385
|
+
/**
|
|
2386
|
+
* `'ata'`(알림톡)·`'bms'`(브랜드 메시지)는 카카오로 나간다. `body` 에는 템플릿에 변수를
|
|
2387
|
+
* 치환한 결과가 담기고, 버튼·아이템 리스트·강조 문구는 템플릿에 담긴 대로 발송되어
|
|
2388
|
+
* 이 값에는 담기지 않는다.
|
|
2389
|
+
*
|
|
2390
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 유형이 하나 늘면 닫힌
|
|
2391
|
+
* enum 은 **목록을 통째로** 실패시킨다(`list()` 는 페이지를 한 번에 파싱한다). 실제로
|
|
2392
|
+
* 두 번 그렇게 터졌다 — `'ata'` 가 나왔을 때, 그리고 `'bms'` 가 나왔을 때.
|
|
2393
|
+
*/
|
|
2394
|
+
type: z.ZodType<MessageType>;
|
|
2395
|
+
to: z.ZodString;
|
|
2396
|
+
from: z.ZodString;
|
|
2397
|
+
body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2398
|
+
subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2399
|
+
numMedia: z.ZodNumber;
|
|
2400
|
+
mediaUrl: z.ZodArray<z.ZodString, "many">;
|
|
2401
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
2402
|
+
accountId: z.ZodString;
|
|
2403
|
+
dateCreated: z.ZodString;
|
|
2404
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2405
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2406
|
+
messageId: z.ZodString;
|
|
2407
|
+
status: z.ZodType<MessageStatus>;
|
|
2408
|
+
/**
|
|
2409
|
+
* `'ata'`(알림톡)·`'bms'`(브랜드 메시지)는 카카오로 나간다. `body` 에는 템플릿에 변수를
|
|
2410
|
+
* 치환한 결과가 담기고, 버튼·아이템 리스트·강조 문구는 템플릿에 담긴 대로 발송되어
|
|
2411
|
+
* 이 값에는 담기지 않는다.
|
|
2412
|
+
*
|
|
2413
|
+
* ⛔ **닫힌 enum 으로 두지 않는다.** 어휘는 서버가 소유하므로, 유형이 하나 늘면 닫힌
|
|
2414
|
+
* enum 은 **목록을 통째로** 실패시킨다(`list()` 는 페이지를 한 번에 파싱한다). 실제로
|
|
2415
|
+
* 두 번 그렇게 터졌다 — `'ata'` 가 나왔을 때, 그리고 `'bms'` 가 나왔을 때.
|
|
2416
|
+
*/
|
|
2417
|
+
type: z.ZodType<MessageType>;
|
|
2418
|
+
to: z.ZodString;
|
|
2419
|
+
from: z.ZodString;
|
|
2420
|
+
body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2421
|
+
subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2422
|
+
numMedia: z.ZodNumber;
|
|
2423
|
+
mediaUrl: z.ZodArray<z.ZodString, "many">;
|
|
2424
|
+
direction: z.ZodEnum<["outbound", "inbound"]>;
|
|
2425
|
+
accountId: z.ZodString;
|
|
2426
|
+
dateCreated: z.ZodString;
|
|
2427
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2428
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2429
|
+
type Message = z.infer<typeof MessageSchema>;
|
|
2430
|
+
|
|
2431
|
+
/** 문자 타입. 발송·대체발송·목록 필터가 같은 어휘를 쓴다. */
|
|
2432
|
+
type TextMessageType = 'sms' | 'lms' | 'mms';
|
|
2433
|
+
/** 문자·알림톡 공통 필드. */
|
|
2434
|
+
interface MessageCreateBaseParams {
|
|
2435
|
+
to: string;
|
|
2436
|
+
from: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* 발송 멱등키. 같은 계정에서 같은 키로 다시 요청하면 발송하지 않고 1회차 결과를 돌려준다.
|
|
2439
|
+
* 재시도·재실행 경로가 있는 호출자만 채운다.
|
|
2440
|
+
*
|
|
2441
|
+
* ⚠️ 순차 재시도를 막는 용도다. 같은 키로 **동시에** 두 요청이 들어오면 둘 다 발송될 수 있다.
|
|
2442
|
+
*/
|
|
2443
|
+
idempotencyKey?: string;
|
|
2444
|
+
}
|
|
2445
|
+
/** SMS/LMS/MMS 발송 파라미터. */
|
|
2446
|
+
interface TextMessageCreateParams extends MessageCreateBaseParams {
|
|
2447
|
+
body: string;
|
|
2448
|
+
/**
|
|
2449
|
+
* 생략하면 서버가 고른다 — `mediaUrl` 이 있으면 `mms`, `subject` 가 있거나 본문이
|
|
2450
|
+
* EUC-KR 90byte(한글 45자)를 넘으면 `lms`, 그 외에는 `sms`.
|
|
2451
|
+
*
|
|
2452
|
+
* `'sms'` 로 명시한 본문이 90byte 를 넘으면 `400 body_too_long` 이다. 길이가 런타임에
|
|
2453
|
+
* 정해지는 경우(템플릿 치환 등)에는 생략하는 편이 안전하다.
|
|
2454
|
+
*/
|
|
2455
|
+
type?: TextMessageType;
|
|
2456
|
+
subject?: string;
|
|
2457
|
+
/** MMS 첨부 (최대 3개). jpg·jpeg·png·bmp, 장당 300KB 이하. */
|
|
2458
|
+
mediaUrl?: string[];
|
|
2459
|
+
kakao?: never;
|
|
2460
|
+
brand?: never;
|
|
2461
|
+
fallback?: never;
|
|
2462
|
+
}
|
|
2463
|
+
/** 알림톡 템플릿 지정. 구조(본문·버튼·아이템·강조)는 검수된 템플릿이 정하고, 요청은 값만 채운다. */
|
|
2464
|
+
interface KakaoSendParams {
|
|
2465
|
+
/** `kakao.channels.list()` 의 `data[].id` (ClawOps 리소스 ID). */
|
|
2466
|
+
channelId: string;
|
|
2467
|
+
/** `kakao.templates.list()` 의 `data[].id` (ClawOps 리소스 ID). */
|
|
2468
|
+
templateId: string;
|
|
2469
|
+
/**
|
|
2470
|
+
* 템플릿 변수. 키는 `고객명` 과 `#{고객명}` 을 모두 받는다.
|
|
2471
|
+
*
|
|
2472
|
+
* 템플릿이 요구하는 변수가 빠지면 `400 kakao_variable_missing`, 템플릿에 없는 변수를 주면
|
|
2473
|
+
* `400 kakao_variable_unknown` 이다. 버튼 링크·강조 문구에 들어간 변수도 같은 목록에 포함된다.
|
|
2474
|
+
*
|
|
2475
|
+
* 채워야 할 이름은 `kakao.templates.list()` 응답의 `variables` 가 알려준다.
|
|
2476
|
+
*/
|
|
2477
|
+
variables?: Record<string, string>;
|
|
2478
|
+
/** 알림톡엔 자유형이 없다 — 브랜드와 한 조립 함수를 쓰기 위한 스탬프이기도 하다. */
|
|
2479
|
+
free?: never;
|
|
2480
|
+
}
|
|
2481
|
+
/** 알림톡이 발송 실패했을 때 대신 나갈 문자. */
|
|
2482
|
+
interface KakaoFallbackParams {
|
|
2483
|
+
/** 생략하면 알림톡 본문(변수 치환 결과)을 그대로 문자로 보낸다. */
|
|
2484
|
+
body?: string;
|
|
2485
|
+
subject?: string;
|
|
2486
|
+
/** 생략하면 본문 길이에 맞춰 서버가 고른다. */
|
|
2487
|
+
type?: TextMessageType;
|
|
2488
|
+
/** `true` 면 알림톡이 실패해도 문자를 보내지 않는다 — 실패가 그대로 실패로 남는다. */
|
|
2489
|
+
disabled?: boolean;
|
|
2490
|
+
}
|
|
2491
|
+
/**
|
|
2492
|
+
* 카카오 알림톡 발송 파라미터.
|
|
2493
|
+
*
|
|
2494
|
+
* **본문은 템플릿이 정한다.** `body`·`subject`·`mediaUrl` 은 실을 수 없고(서버가 400),
|
|
2495
|
+
* 버튼·아이템 리스트·강조 문구는 카카오 검수를 받은 그대로 발송된다 — 요청으로 바꿀 수 없다.
|
|
2496
|
+
*
|
|
2497
|
+
* 대체발송된 문자는 **별도의 메시지 1건**으로 기록되고 문자 단가로 청구된다.
|
|
2498
|
+
*/
|
|
2499
|
+
interface KakaoMessageCreateParams extends MessageCreateBaseParams {
|
|
2500
|
+
kakao: KakaoSendParams;
|
|
2501
|
+
brand?: never;
|
|
2502
|
+
fallback?: KakaoFallbackParams;
|
|
2503
|
+
/** `kakao` 를 실으면 알림톡이다. 명시할 필요가 없고, 명시한다면 `'ata'` 뿐이다. */
|
|
2504
|
+
type?: 'ata';
|
|
2505
|
+
body?: never;
|
|
2506
|
+
subject?: never;
|
|
2507
|
+
mediaUrl?: never;
|
|
2508
|
+
}
|
|
2509
|
+
interface BrandSendBaseParams {
|
|
2510
|
+
/** `kakao.channels.list()` 의 `data[].id` (ClawOps 리소스 ID). */
|
|
2511
|
+
channelId: string;
|
|
2512
|
+
}
|
|
2513
|
+
/** 템플릿형 — 구조(본문·버튼·이미지)는 등록한 템플릿이 정하고 요청은 값만 채운다. */
|
|
2514
|
+
interface BrandTemplateSendParams extends BrandSendBaseParams {
|
|
2515
|
+
/**
|
|
2516
|
+
* `kakao.brandTemplates.list()` 의 `data[].id` (ClawOps 리소스 ID).
|
|
2517
|
+
*/
|
|
2518
|
+
templateId: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* 템플릿 변수. 키는 `고객명` 과 `#{고객명}` 을 모두 받는다.
|
|
2521
|
+
*
|
|
2522
|
+
* 채워야 할 이름은 `kakao.brandTemplates.list()` 응답의 `variables` 가 알려준다.
|
|
2523
|
+
*/
|
|
2524
|
+
variables?: Record<string, string>;
|
|
2525
|
+
free?: never;
|
|
2526
|
+
}
|
|
2527
|
+
/**
|
|
2528
|
+
* 자유형 — 말풍선을 요청이 직접 들고 간다. 템플릿을 등록하지 않아도 된다.
|
|
2529
|
+
*
|
|
2530
|
+
* 종료된 친구톡을 대신하는 방식이다.
|
|
2531
|
+
*
|
|
2532
|
+
* ⛔ **변수를 쓸 수 없다.** 치환해 줄 템플릿이 없어 `#{…}` 가 그대로 톡에 렌더되므로
|
|
2533
|
+
* 서버가 `400` 으로 막는다. 값을 채우려면 템플릿형을 쓴다.
|
|
2534
|
+
*/
|
|
2535
|
+
interface BrandFreeSendParams extends BrandSendBaseParams {
|
|
2536
|
+
/**
|
|
2537
|
+
* 말풍선 몸통. **불투명 오브젝트다 — SDK 는 안을 검사하지 않는다.**
|
|
2538
|
+
*
|
|
2539
|
+
* ⛔ 칸마다 타이핑하지 않는 것이 의도다. 말풍선 규격표는 서버에 한 벌만 있고, SDK 가
|
|
2540
|
+
* 사본을 들면 카카오가 칸을 늘린 날 **SDK 가 조용히 깎는다.** 잘못된 몸통은
|
|
2541
|
+
* `400 VALIDATION`(도메인) 또는 `400`+`errors`(스펙)로 돌아온다.
|
|
2542
|
+
*
|
|
2543
|
+
* `chatBubbleType` 이 규격을 정한다. 이미지가 필요한 유형은
|
|
2544
|
+
* `kakao.brandImages.upload()` 로 먼저 올리고 받은 `id` 를 `imageId` 에 넣는다.
|
|
2545
|
+
*
|
|
2546
|
+
* ⚠️ `interface` 로 선언한 값은 `Record<string, unknown>` 에 대입되지 않는다(암묵 인덱스
|
|
2547
|
+
* 시그니처가 없다). `free: { ...myBubble }` 로 펼치거나 `type` 으로 선언할 것.
|
|
2548
|
+
*/
|
|
2549
|
+
free: Record<string, unknown>;
|
|
2550
|
+
templateId?: never;
|
|
2551
|
+
variables?: never;
|
|
2552
|
+
}
|
|
2553
|
+
/**
|
|
2554
|
+
* 브랜드 메시지 발송 지정. **템플릿형(`templateId`)과 자유형(`free`)은 정확히 하나만**
|
|
2555
|
+
* 성립한다 — 둘 다 실으면 어느 쪽으로 나갈지 정해 줄 수 없고, 둘 다 없으면 보낼 말풍선이
|
|
2556
|
+
* 없다. 서버도 `400 invalid_input` 이다.
|
|
2557
|
+
*
|
|
2558
|
+
* ⛔ **평평한 optional 로 합치지 말 것.** `templateId?`·`free?` 로 두면 `{ channelId }`
|
|
2559
|
+
* 하나만 준 오타가 컴파일을 통과해 **운영 트래픽의 런타임 400** 이 된다.
|
|
2560
|
+
*/
|
|
2561
|
+
type BrandSendParams = BrandTemplateSendParams | BrandFreeSendParams;
|
|
2562
|
+
/**
|
|
2563
|
+
* 카카오 브랜드 메시지 발송 파라미터.
|
|
2564
|
+
*
|
|
2565
|
+
* 채널을 **추가한 친구**에게 나가는 광고성 메시지다. 알림톡과 갈리는 점 둘:
|
|
2566
|
+
*
|
|
2567
|
+
* - **야간에 못 보낸다.** 20:50~08:00(KST)은 `422 kakao_brand_night_blocked` 다.
|
|
2568
|
+
* - **대체발송이 없다.** `fallback` 을 실으면 `400 kakao_fallback_not_allowed` 라서
|
|
2569
|
+
* 타입에서도 막는다.
|
|
2570
|
+
*
|
|
2571
|
+
* `(광고)` 표기와 수신거부 안내는 카카오가 붙이므로 본문에 넣지 않는다.
|
|
2572
|
+
*/
|
|
2573
|
+
interface BrandMessageCreateParams extends MessageCreateBaseParams {
|
|
2574
|
+
brand: BrandSendParams;
|
|
2575
|
+
/** `brand` 를 실으면 브랜드 메시지다. 명시할 필요가 없고, 명시한다면 `'bms'` 뿐이다. */
|
|
2576
|
+
type?: 'bms';
|
|
2577
|
+
body?: never;
|
|
2578
|
+
subject?: never;
|
|
2579
|
+
mediaUrl?: never;
|
|
2580
|
+
kakao?: never;
|
|
2581
|
+
fallback?: never;
|
|
2582
|
+
}
|
|
2583
|
+
/**
|
|
2584
|
+
* 발송 파라미터. 문자·알림톡·브랜드 메시지는 **서로 배타적**이다 — 서버 규칙이 그렇고,
|
|
2585
|
+
* 섞으면 컴파일 에러다.
|
|
2586
|
+
*/
|
|
2587
|
+
type MessageCreateParams = TextMessageCreateParams | KakaoMessageCreateParams | BrandMessageCreateParams;
|
|
2588
|
+
interface MessageListParams {
|
|
2589
|
+
type?: TextMessageType | 'ata' | 'bms';
|
|
2590
|
+
status?: 'queued' | 'sent' | 'failed' | 'received';
|
|
2591
|
+
/** 발신 또는 수신 번호. 하이픈 유무를 모두 매칭한다. */
|
|
2592
|
+
number?: string;
|
|
2593
|
+
page?: number;
|
|
2594
|
+
pageSize?: number;
|
|
2595
|
+
}
|
|
2596
|
+
|
|
2597
|
+
declare class Messages extends APIResource {
|
|
2598
|
+
/**
|
|
2599
|
+
* 문자(SMS/LMS/MMS) 또는 카카오 알림톡·브랜드 메시지를 발송합니다.
|
|
2600
|
+
*
|
|
2601
|
+
* 셋은 배타적입니다 — `kakao` 를 실으면 알림톡, `brand` 를 실으면 브랜드 메시지이고,
|
|
2602
|
+
* 이때 `body`·`subject`·`mediaUrl` 은 실을 수 없습니다(본문은 템플릿이 정합니다).
|
|
2603
|
+
*
|
|
2604
|
+
* ```ts
|
|
2605
|
+
* // 문자
|
|
2606
|
+
* await client.messages.create({ to: '010…', from: '070…', body: '안녕하세요' });
|
|
2607
|
+
*
|
|
2608
|
+
* // 알림톡 — 실패하면 fallback 문구가 문자로 대신 나갑니다(별도 1건으로 과금)
|
|
2609
|
+
* await client.messages.create({
|
|
2610
|
+
* to: '010…',
|
|
2611
|
+
* from: '070…',
|
|
2612
|
+
* kakao: { channelId, templateId, variables: { 고객명: '홍길동' } },
|
|
2613
|
+
* fallback: { body: '주문이 접수되었습니다.' },
|
|
2614
|
+
* });
|
|
2615
|
+
*
|
|
2616
|
+
* // 브랜드 메시지 — 채널을 추가한 친구에게 나가는 광고성 메시지
|
|
2617
|
+
* // ⚠️ 야간 제한과 대체발송 없음 — 제약은 `BrandMessageCreateParams` 참고.
|
|
2618
|
+
* await client.messages.create({
|
|
2619
|
+
* to: '010…',
|
|
2620
|
+
* from: '070…',
|
|
2621
|
+
* brand: { channelId, templateId, variables: { 고객명: '홍길동' } },
|
|
2622
|
+
* });
|
|
2623
|
+
* ```
|
|
2624
|
+
*/
|
|
2625
|
+
create(params: MessageCreateParams, options?: {
|
|
2626
|
+
extraHeaders?: Record<string, string>;
|
|
2627
|
+
extraQuery?: Record<string, unknown>;
|
|
2628
|
+
timeout?: number;
|
|
2629
|
+
}): Promise<Message>;
|
|
2630
|
+
list(params?: MessageListParams, options?: {
|
|
2631
|
+
extraHeaders?: Record<string, string>;
|
|
2632
|
+
extraQuery?: Record<string, unknown>;
|
|
2633
|
+
timeout?: number;
|
|
2634
|
+
}): Promise<Page<Message>>;
|
|
2635
|
+
get(messageId: string, options?: {
|
|
2636
|
+
extraHeaders?: Record<string, string>;
|
|
2637
|
+
extraQuery?: Record<string, unknown>;
|
|
2638
|
+
timeout?: number;
|
|
2639
|
+
}): Promise<Message>;
|
|
2640
|
+
}
|
|
2641
|
+
|
|
2642
|
+
/**
|
|
2643
|
+
* 착신 라우팅 모드.
|
|
2644
|
+
*
|
|
2645
|
+
* - `webhook` : webhookUrl 의 VoiceML 이 처리.
|
|
2646
|
+
* - `agent` : agentId 의 매니지드 에이전트가 착신.
|
|
2647
|
+
* - `callflow` : callFlowId 의 콜 플로우(ARS)가 착신.
|
|
2648
|
+
* - `forward` : forwardTo(같은 계정 보유 번호)로 내부 착신전환.
|
|
2649
|
+
* - `sip` : sipEndpointId 의 라우트로 외부 PBX 다이얼.
|
|
2650
|
+
* - `softphone` : sipCredentialId 의 등록 단말로 착신.
|
|
2651
|
+
*/
|
|
2652
|
+
declare const ROUTING_TYPES: readonly ["webhook", "sip", "softphone", "forward", "agent", "callflow"];
|
|
2653
|
+
type RoutingType = (typeof ROUTING_TYPES)[number];
|
|
2654
|
+
declare const PhoneNumberSchema: z.ZodObject<{
|
|
2655
|
+
number: z.ZodString;
|
|
2656
|
+
numberType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2657
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2658
|
+
routingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2659
|
+
agentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2660
|
+
callFlowId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2661
|
+
forwardTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2662
|
+
sipEndpointId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2663
|
+
sipCredentialId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2664
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2665
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2666
|
+
webhookHeaders: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
2667
|
+
callContextUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2668
|
+
statusCallback: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2669
|
+
statusCallbackEvents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2670
|
+
dictionaryId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2671
|
+
createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2672
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2673
|
+
number: z.ZodString;
|
|
2674
|
+
numberType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2675
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2676
|
+
routingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2677
|
+
agentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2678
|
+
callFlowId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2679
|
+
forwardTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2680
|
+
sipEndpointId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2681
|
+
sipCredentialId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2682
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2683
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2684
|
+
webhookHeaders: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
2685
|
+
callContextUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2686
|
+
statusCallback: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2687
|
+
statusCallbackEvents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2688
|
+
dictionaryId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2689
|
+
createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2690
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2691
|
+
number: z.ZodString;
|
|
2692
|
+
numberType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2693
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2694
|
+
routingType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2695
|
+
agentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2696
|
+
callFlowId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2697
|
+
forwardTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2698
|
+
sipEndpointId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2699
|
+
sipCredentialId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2700
|
+
webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2701
|
+
webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2702
|
+
webhookHeaders: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
2703
|
+
callContextUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2704
|
+
statusCallback: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2705
|
+
statusCallbackEvents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2706
|
+
dictionaryId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2707
|
+
createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2708
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2709
|
+
/**
|
|
2710
|
+
* 전화번호. `routingType` 은 알려진 값에 자동완성이 뜨지만, 서버가 새 라우팅을 추가해도
|
|
2711
|
+
* 파싱이 깨지지 않도록 임의의 문자열을 허용한다.
|
|
2712
|
+
*/
|
|
2713
|
+
type PhoneNumber = Omit<z.infer<typeof PhoneNumberSchema>, 'routingType'> & {
|
|
2714
|
+
routingType?: RoutingType | (string & {}) | null;
|
|
2715
|
+
};
|
|
2716
|
+
type ProvisionedPhoneNumber = PhoneNumber & {
|
|
2717
|
+
smsSender?: SmsSenderRegistration;
|
|
2718
|
+
};
|
|
2719
|
+
type NumberListItem = PhoneNumber;
|
|
2720
|
+
type NumberUpdateResponse = PhoneNumber;
|
|
2721
|
+
|
|
2722
|
+
interface NumberCreateParams {
|
|
2723
|
+
/** 수신 전화 처리용 Webhook URL. */
|
|
2724
|
+
webhookUrl?: string;
|
|
2725
|
+
/** Webhook 호출 HTTP 메서드. */
|
|
2726
|
+
webhookMethod?: 'POST' | 'GET';
|
|
2727
|
+
/** Webhook 호출 시 덧붙일 헤더. 키는 'X-' 로 시작해야 한다. */
|
|
2728
|
+
webhookHeaders?: Record<string, string>;
|
|
2729
|
+
/** 수신(inbound) 통화 상태 통지 URL. */
|
|
2730
|
+
statusCallback?: string;
|
|
2731
|
+
/** 구독할 상태 이벤트(공백 구분). 미지정 시 'initiated ringing answered completed'. */
|
|
2732
|
+
statusCallbackEvents?: string;
|
|
2733
|
+
}
|
|
2734
|
+
interface NumberUpdateParams {
|
|
2735
|
+
/** 착신 라우팅 모드. */
|
|
2736
|
+
routingType?: RoutingType;
|
|
2737
|
+
/** routingType='agent' 일 때 필수. 같은 계정의 에이전트 id. */
|
|
2738
|
+
agentId?: string | null;
|
|
2739
|
+
/** routingType='callflow' 일 때 필수. 같은 계정의 콜 플로우 id. */
|
|
2740
|
+
callFlowId?: string | null;
|
|
2741
|
+
/** routingType='forward' 일 때 필수. 같은 계정이 보유한 번호. */
|
|
2742
|
+
forwardTo?: string | null;
|
|
2743
|
+
/** routingType='sip' 일 때 필수. SipEndpoint id. */
|
|
2744
|
+
sipEndpointId?: string | null;
|
|
2745
|
+
/** routingType='softphone' 일 때 필수. 등록 단말의 SIP credential id. */
|
|
2746
|
+
sipCredentialId?: string | null;
|
|
2747
|
+
/** 수신 전화 처리용 Webhook URL. */
|
|
2748
|
+
webhookUrl?: string;
|
|
2749
|
+
/** Webhook 호출 HTTP 메서드. */
|
|
2750
|
+
webhookMethod?: 'POST' | 'GET';
|
|
2751
|
+
/** Webhook 호출 시 덧붙일 헤더. */
|
|
2752
|
+
webhookHeaders?: Record<string, string> | null;
|
|
2753
|
+
/** routingType='agent' 에서 통화별 컨텍스트를 조회할 endpoint. */
|
|
2754
|
+
callContextUrl?: string | null;
|
|
2755
|
+
/** 수신(inbound) 통화 상태 통지 URL. */
|
|
2756
|
+
statusCallback?: string | null;
|
|
2757
|
+
/** 구독할 상태 이벤트(공백 구분). */
|
|
2758
|
+
statusCallbackEvents?: string | null;
|
|
2759
|
+
/** 이 번호의 통화 전사에 적용할 받아쓰기 사전 id. */
|
|
2760
|
+
dictionaryId?: string | null;
|
|
2761
|
+
}
|
|
2762
|
+
|
|
2763
|
+
interface RequestOptions {
|
|
2764
|
+
extraHeaders?: Record<string, string>;
|
|
2765
|
+
extraQuery?: Record<string, unknown>;
|
|
2766
|
+
timeout?: number;
|
|
2767
|
+
}
|
|
2768
|
+
declare class Numbers extends APIResource {
|
|
2769
|
+
/**
|
|
2770
|
+
* 번호를 발급합니다. 번호 풀에서 자동으로 배정되며 어떤 번호가 나올지는 지정할 수 없습니다.
|
|
2771
|
+
*
|
|
2772
|
+
* 발급 직후 번호는 `routingType: "webhook"` 이고 `webhookUrl` 이 비어 있어, 그대로 두면
|
|
2773
|
+
* 걸려온 전화가 거절됩니다. 이어서 `update()` 로 착신 라우팅을 지정하세요.
|
|
2774
|
+
*
|
|
2775
|
+
* 회선 수 한도 안이면 문자 발신번호로도 자동 등록되며, 결과는 `smsSender` 에 실립니다.
|
|
2776
|
+
* `smsSender.registered` 가 `false` 여도 발급은 성공입니다 — 그 번호로 문자를 보내려면
|
|
2777
|
+
* `reason` 을 해결한 뒤 `senderNumbers.create()` 로 등록하세요.
|
|
2778
|
+
*/
|
|
2779
|
+
create(params?: NumberCreateParams, options?: RequestOptions): Promise<ProvisionedPhoneNumber>;
|
|
2780
|
+
/**
|
|
2781
|
+
* 등록된 번호 목록을 조회합니다. 페이지네이션과 필터가 없으며 보유한 번호가 한 번에 전부
|
|
2782
|
+
* 반환됩니다.
|
|
2783
|
+
*/
|
|
2784
|
+
list(options?: RequestOptions): Promise<NumberListItem[]>;
|
|
2785
|
+
/**
|
|
2786
|
+
* 번호 설정을 수정합니다. 착신 라우팅(webhook/agent/callflow/forward/sip/softphone)과
|
|
2787
|
+
* webhook, 상태 통지, 받아쓰기 사전을 변경할 수 있습니다. 보낸 필드만 반영되고 생략한
|
|
2788
|
+
* 필드는 유지됩니다.
|
|
2789
|
+
*
|
|
2790
|
+
* 라우팅을 바꾸면 다른 라우팅 필드는 서버에서 자동으로 비워집니다. `agent` 에서
|
|
2791
|
+
* `webhook` 으로 되돌리면 `agentId` 가 null 이 되므로, 다시 `agent` 로 돌아갈 때
|
|
2792
|
+
* `agentId` 를 새로 지정해야 합니다.
|
|
2793
|
+
*/
|
|
2794
|
+
update(number: string, params?: NumberUpdateParams, options?: RequestOptions): Promise<NumberUpdateResponse>;
|
|
2795
|
+
/**
|
|
2796
|
+
* 번호를 반납합니다. 번호는 풀로 복귀하며 되돌릴 수 없습니다. 같은 번호를 다시
|
|
2797
|
+
* 발급받는다는 보장이 없습니다.
|
|
2798
|
+
*/
|
|
2799
|
+
delete(number: string, options?: {
|
|
2800
|
+
extraHeaders?: Record<string, string>;
|
|
2801
|
+
timeout?: number;
|
|
2802
|
+
}): Promise<void>;
|
|
2803
|
+
}
|
|
2804
|
+
|
|
2805
|
+
interface RecordingDownload {
|
|
2806
|
+
/** WAV 바이너리 데이터 (PCM 16bit mono 8kHz) */
|
|
2807
|
+
data: ArrayBuffer;
|
|
2808
|
+
/** 응답의 Content-Type (예: 'audio/wav') */
|
|
2809
|
+
contentType: string;
|
|
2810
|
+
/** Content-Disposition 헤더에서 파싱한 파일명 (없으면 null) */
|
|
2811
|
+
filename: string | null;
|
|
2812
|
+
}
|
|
2813
|
+
declare class Recordings extends APIResource {
|
|
2814
|
+
/**
|
|
2815
|
+
* 통화 녹음(WAV)을 다운로드합니다.
|
|
2816
|
+
*
|
|
2817
|
+
* 콘솔과 동일한 서버측 MixMonitor 원본 (PCM 16bit mono 8kHz).
|
|
2818
|
+
*
|
|
2819
|
+
* @throws NotFoundError (404) — 통화가 없거나 녹음이 없음(`recordingUrl: null`).
|
|
2820
|
+
* @throws PermissionDeniedError (403) — accountId 불일치.
|
|
2821
|
+
*/
|
|
2822
|
+
download(callId: string, options?: {
|
|
2823
|
+
extraHeaders?: Record<string, string>;
|
|
2824
|
+
extraQuery?: Record<string, unknown>;
|
|
2825
|
+
timeout?: number;
|
|
2826
|
+
}): Promise<RecordingDownload>;
|
|
2827
|
+
/**
|
|
2828
|
+
* 통화 녹음을 삭제합니다 (포인터 제거, 멱등 — 이미 없어도 성공).
|
|
2829
|
+
*
|
|
2830
|
+
* @throws NotFoundError (404) — 통화가 없음.
|
|
2831
|
+
* @throws PermissionDeniedError (403) — accountId 불일치.
|
|
2832
|
+
*/
|
|
2833
|
+
delete(callId: string, options?: {
|
|
2834
|
+
extraHeaders?: Record<string, string>;
|
|
2835
|
+
timeout?: number;
|
|
2836
|
+
}): Promise<void>;
|
|
2837
|
+
}
|
|
2838
|
+
|
|
2839
|
+
/**
|
|
2840
|
+
* SIP 단말(digest credential). 평문 password/ha1 은 조회 응답에 포함되지 않음
|
|
2841
|
+
* (생성 시 1회만 노출). softphone 라우팅 설정 시 이 객체의 id 를
|
|
2842
|
+
* numbers.update(number, { sipCredentialId }) 로 넘긴다.
|
|
2843
|
+
*/
|
|
2844
|
+
declare const SipCredentialSchema: z.ZodObject<{
|
|
2845
|
+
id: z.ZodString;
|
|
2846
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2847
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2848
|
+
username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2849
|
+
realm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2850
|
+
enabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
2851
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled", "deleted"]>>>;
|
|
2852
|
+
ipAclId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2853
|
+
allowedNumbers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
|
|
2854
|
+
lastUsedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2855
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2856
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2857
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2858
|
+
id: z.ZodString;
|
|
2859
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2860
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2861
|
+
username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2862
|
+
realm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2863
|
+
enabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
2864
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled", "deleted"]>>>;
|
|
2865
|
+
ipAclId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2866
|
+
allowedNumbers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
|
|
2867
|
+
lastUsedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2868
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2869
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2870
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2871
|
+
id: z.ZodString;
|
|
2872
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2873
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2874
|
+
username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2875
|
+
realm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2876
|
+
enabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
2877
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled", "deleted"]>>>;
|
|
2878
|
+
ipAclId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2879
|
+
allowedNumbers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
|
|
2880
|
+
lastUsedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2881
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2882
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2883
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2884
|
+
type SipCredential = z.infer<typeof SipCredentialSchema>;
|
|
2885
|
+
/**
|
|
2886
|
+
* SIP 엔드포인트(외부 PBX 트렁크). sip 라우팅 설정 시 이 객체의 id 를
|
|
2887
|
+
* numbers.update(number, { sipEndpointId }) 로 넘긴다.
|
|
2888
|
+
*/
|
|
2889
|
+
declare const SipEndpointSchema: z.ZodObject<{
|
|
2890
|
+
id: z.ZodString;
|
|
2891
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2892
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2893
|
+
maxConcurrent: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2894
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled"]>>>;
|
|
2895
|
+
routes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown, "many">>>;
|
|
2896
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2897
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2898
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2899
|
+
id: z.ZodString;
|
|
2900
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2901
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2902
|
+
maxConcurrent: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2903
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled"]>>>;
|
|
2904
|
+
routes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown, "many">>>;
|
|
2905
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2906
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2907
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2908
|
+
id: z.ZodString;
|
|
2909
|
+
accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2910
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2911
|
+
maxConcurrent: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2912
|
+
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["active", "disabled"]>>>;
|
|
2913
|
+
routes: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown, "many">>>;
|
|
2914
|
+
dateCreated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2915
|
+
dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2916
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
2917
|
+
type SipEndpoint = z.infer<typeof SipEndpointSchema>;
|
|
2918
|
+
|
|
2919
|
+
/**
|
|
2920
|
+
* SIP 단말(credential) 리소스 — 조회 전용.
|
|
2921
|
+
* 생성/수정/삭제는 대시보드 또는 REST API 사용. 본 SDK 는 softphone 라우팅 설정에
|
|
2922
|
+
* 필요한 credential id 확인용 list/get 만 제공한다 (password/ha1 미노출).
|
|
2923
|
+
*/
|
|
2924
|
+
declare class SipCredentials extends APIResource {
|
|
2925
|
+
list(params?: {
|
|
2926
|
+
status?: 'active' | 'disabled';
|
|
2927
|
+
page?: number;
|
|
2928
|
+
pageSize?: number;
|
|
2929
|
+
}, options?: {
|
|
2930
|
+
extraHeaders?: Record<string, string>;
|
|
2931
|
+
extraQuery?: Record<string, unknown>;
|
|
2932
|
+
timeout?: number;
|
|
2933
|
+
}): Promise<SipCredential[]>;
|
|
2934
|
+
get(credentialId: string, options?: {
|
|
2935
|
+
extraHeaders?: Record<string, string>;
|
|
2936
|
+
timeout?: number;
|
|
2937
|
+
}): Promise<SipCredential>;
|
|
2938
|
+
}
|
|
2939
|
+
|
|
2940
|
+
/**
|
|
2941
|
+
* SIP 엔드포인트(외부 PBX 트렁크) 리소스 — 조회 전용.
|
|
2942
|
+
* 생성/수정/삭제는 대시보드 또는 REST API 사용. 본 SDK 는 sip 라우팅 설정에
|
|
2943
|
+
* 필요한 endpoint id 확인용 list/get 만 제공한다.
|
|
2944
|
+
*/
|
|
2945
|
+
declare class SipEndpoints extends APIResource {
|
|
2946
|
+
list(params?: {
|
|
2947
|
+
status?: 'active' | 'disabled';
|
|
2948
|
+
page?: number;
|
|
2949
|
+
pageSize?: number;
|
|
2950
|
+
}, options?: {
|
|
2951
|
+
extraHeaders?: Record<string, string>;
|
|
2952
|
+
extraQuery?: Record<string, unknown>;
|
|
2953
|
+
timeout?: number;
|
|
2954
|
+
}): Promise<SipEndpoint[]>;
|
|
2955
|
+
get(endpointId: string, options?: {
|
|
2956
|
+
extraHeaders?: Record<string, string>;
|
|
2957
|
+
timeout?: number;
|
|
2958
|
+
}): Promise<SipEndpoint>;
|
|
2959
|
+
}
|
|
2960
|
+
|
|
2961
|
+
declare const WebhookLogSchema: z.ZodObject<{
|
|
2962
|
+
id: z.ZodString;
|
|
2963
|
+
webhookId: z.ZodString;
|
|
2964
|
+
event: z.ZodString;
|
|
2965
|
+
requestUrl: z.ZodString;
|
|
2966
|
+
requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2967
|
+
responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2968
|
+
responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2969
|
+
responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2970
|
+
status: z.ZodEnum<["pending", "delivered", "failed"]>;
|
|
2971
|
+
attempt: z.ZodNumber;
|
|
2972
|
+
maxAttempts: z.ZodNumber;
|
|
2973
|
+
createdAt: z.ZodString;
|
|
2974
|
+
completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2975
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
2976
|
+
id: z.ZodString;
|
|
2977
|
+
webhookId: z.ZodString;
|
|
2978
|
+
event: z.ZodString;
|
|
2979
|
+
requestUrl: z.ZodString;
|
|
2980
|
+
requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2981
|
+
responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2982
|
+
responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2983
|
+
responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2984
|
+
status: z.ZodEnum<["pending", "delivered", "failed"]>;
|
|
2985
|
+
attempt: z.ZodNumber;
|
|
2986
|
+
maxAttempts: z.ZodNumber;
|
|
2987
|
+
createdAt: z.ZodString;
|
|
2988
|
+
completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2989
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
2990
|
+
id: z.ZodString;
|
|
2991
|
+
webhookId: z.ZodString;
|
|
2992
|
+
event: z.ZodString;
|
|
2993
|
+
requestUrl: z.ZodString;
|
|
2994
|
+
requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2995
|
+
responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2996
|
+
responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2997
|
+
responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
2998
|
+
status: z.ZodEnum<["pending", "delivered", "failed"]>;
|
|
2999
|
+
attempt: z.ZodNumber;
|
|
3000
|
+
maxAttempts: z.ZodNumber;
|
|
3001
|
+
createdAt: z.ZodString;
|
|
3002
|
+
completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3003
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
3004
|
+
type WebhookLog = z.infer<typeof WebhookLogSchema>;
|
|
3005
|
+
|
|
3006
|
+
declare class WebhookLogs extends APIResource {
|
|
3007
|
+
list(webhookId: string, params?: {
|
|
3008
|
+
page?: number;
|
|
3009
|
+
pageSize?: number;
|
|
3010
|
+
}, options?: {
|
|
3011
|
+
extraHeaders?: Record<string, string>;
|
|
3012
|
+
extraQuery?: Record<string, unknown>;
|
|
3013
|
+
timeout?: number;
|
|
3014
|
+
}): Promise<Page<WebhookLog>>;
|
|
3015
|
+
}
|
|
3016
|
+
|
|
3017
|
+
declare class AccountContext {
|
|
3018
|
+
private _client;
|
|
3019
|
+
private _accountId;
|
|
3020
|
+
constructor(client: APIClient, accountId: string);
|
|
3021
|
+
get calls(): Calls;
|
|
3022
|
+
get messages(): Messages;
|
|
3023
|
+
get numbers(): Numbers;
|
|
3024
|
+
get recordings(): Recordings;
|
|
3025
|
+
get webhookLogs(): WebhookLogs;
|
|
3026
|
+
get assignmentLinks(): AssignmentLinks;
|
|
3027
|
+
get blockedRecipients(): BlockedRecipients;
|
|
3028
|
+
get senderNumbers(): SenderNumbers;
|
|
3029
|
+
get kakao(): Kakao;
|
|
3030
|
+
}
|
|
3031
|
+
|
|
3032
|
+
declare class WebhookVerificationError extends ClawOpsError {
|
|
3033
|
+
constructor(message?: string);
|
|
3034
|
+
}
|
|
3035
|
+
declare class Webhooks {
|
|
3036
|
+
verify(options: {
|
|
3037
|
+
url: string;
|
|
3038
|
+
params: Record<string, string>;
|
|
3039
|
+
signature: string;
|
|
3040
|
+
signingKey: string;
|
|
3041
|
+
}): boolean;
|
|
3042
|
+
static _computeSignature(url: string, params: Record<string, string>, signingKey: string): string;
|
|
3043
|
+
}
|
|
3044
|
+
|
|
3045
|
+
interface ClawOpsOptions {
|
|
3046
|
+
apiKey?: string;
|
|
3047
|
+
accountId?: string;
|
|
3048
|
+
baseURL?: string;
|
|
3049
|
+
timeout?: number;
|
|
3050
|
+
maxRetries?: number;
|
|
3051
|
+
fetch?: typeof globalThis.fetch;
|
|
3052
|
+
defaultHeaders?: Record<string, string>;
|
|
3053
|
+
}
|
|
3054
|
+
declare class ClawOps extends APIClient {
|
|
3055
|
+
private _defaultAccountId;
|
|
3056
|
+
constructor(options?: ClawOpsOptions);
|
|
3057
|
+
get calls(): Calls;
|
|
3058
|
+
get messages(): Messages;
|
|
3059
|
+
get numbers(): Numbers;
|
|
3060
|
+
get sipCredentials(): SipCredentials;
|
|
3061
|
+
get sipEndpoints(): SipEndpoints;
|
|
3062
|
+
get recordings(): Recordings;
|
|
3063
|
+
get webhookLogs(): WebhookLogs;
|
|
3064
|
+
get assignmentLinks(): AssignmentLinks;
|
|
3065
|
+
get blockedRecipients(): BlockedRecipients;
|
|
3066
|
+
/** 문자 발신번호 — 조회·등록·삭제(clawops#1489). */
|
|
3067
|
+
get senderNumbers(): SenderNumbers;
|
|
3068
|
+
/** 카카오 채널·알림톡 템플릿. 발송은 `messages.create({ kakao: … })` 다. */
|
|
3069
|
+
get kakao(): Kakao;
|
|
3070
|
+
get webhooks(): Webhooks;
|
|
3071
|
+
accounts(accountId: string): AccountContext;
|
|
3072
|
+
}
|
|
3073
|
+
|
|
3074
|
+
export { type NumberListItem as $, APIClient as A, type BlockedChannel as B, type Call as C, type KakaoBrandTemplate as D, type KakaoBrandTemplateListParams as E, KakaoBrandTemplates as F, type KakaoChannel as G, type KakaoChannelCategory as H, type KakaoChannelCategoryList as I, type KakaoChannelConnectParams as J, Kakao as K, type KakaoChannelListParams as L, type KakaoChannelStatus as M, KakaoChannels as N, type KakaoFallbackParams as O, type KakaoMessageCreateParams as P, type KakaoSendParams as Q, type KakaoTemplate as R, type KakaoTemplateListParams as S, KakaoTemplates as T, type KakaoTokenRequest as U, type KakaoTokenRequestParams as V, type Message as W, type MessageCreateParams as X, type MessageListParams as Y, Messages as Z, type NumberCreateParams as _, type APIClientOptions as a, type NumberUpdateParams as a0, type NumberUpdateResponse as a1, Numbers as a2, Page as a3, type PhoneNumber as a4, type ProvisionedPhoneNumber as a5, type RecordingDownload as a6, Recordings as a7, type RoutingType as a8, type SenderNumber as a9, type SenderNumberGrace as aa, type SenderNumberLimit as ab, type SenderNumberList as ac, SenderNumbers as ad, type SipCredential as ae, SipCredentials as af, type SipEndpoint as ag, SipEndpoints as ah, type SmsSenderRegistration as ai, type TextMessageCreateParams as aj, type TransferLeg as ak, type WebhookLog as al, WebhookLogs as am, WebhookVerificationError as an, Webhooks as ao, AccountContext as b, type AssignmentLink as c, type AssignmentLinkAssignment as d, type AssignmentLinkCreateResponse as e, type AssignmentLinkStatus as f, AssignmentLinks as g, type BlockedRecipient as h, type BlockedRecipientSource as i, type BlockedRecipientStatus as j, BlockedRecipients as k, type BrandBubbleType as l, type BrandFreeSendParams as m, type BrandMessageCreateParams as n, type BrandSendParams as o, type BrandTemplateSendParams as p, type CallContextParam as q, type CallControlResponse as r, type CallCreateParams as s, type CallListParams as t, type CallUpdateParams as u, Calls as v, ClawOps as w, type ClawOpsOptions as x, type KakaoBrandImage as y, KakaoBrandImages as z };
|