@ztlink-imk/ztlinkcloud-agent-sdk 1.0.2 → 1.0.3

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/dist/index.d.cts CHANGED
@@ -7,7 +7,7 @@
7
7
  * 错误对象与消息都已脱敏:不含 Token、密码、请求体和服务端原始报文。
8
8
  */
9
9
  /** 后端契约错误码(http-contract.md §12) */
10
- type ServerErrorCode = 'BAD_REQUEST' | 'VALIDATION_ERROR' | 'TOKEN_MISSING' | 'TOKEN_INVALID' | 'TOKEN_EXPIRED' | 'SESSION_REVOKED' | 'SESSION_EXPIRED' | 'TICKET_INVALID' | 'TICKET_EXPIRED' | 'TICKET_USED' | 'REFRESH_TOKEN_INVALID' | 'REFRESH_TOKEN_REPLAYED' | 'REFRESH_NOT_COMMITTED' | 'PERMISSION_DENIED' | 'APP_DISABLED' | 'AGENT_DISABLED' | 'AGENT_NOT_FOUND' | 'AGENT_ALREADY_EXISTS' | 'CALL_CONTROL_REJECTED' | 'AGENT_SIP_NOT_READY' | 'AGENT_CONFLICT' | 'RATE_LIMITED' | 'INTERNAL_ERROR' | 'PROVIDER_BAD_RESPONSE' | 'SERVICE_UNAVAILABLE' | 'SIP_CREDENTIAL_UNAVAILABLE' | 'PROVIDER_TIMEOUT' | 'NOT_FOUND' | 'METHOD_NOT_ALLOWED' | 'UNSUPPORTED_MEDIA_TYPE';
10
+ type ServerErrorCode = 'BAD_REQUEST' | 'VALIDATION_ERROR' | 'TOKEN_MISSING' | 'TOKEN_INVALID' | 'TOKEN_EXPIRED' | 'SESSION_REVOKED' | 'SESSION_EXPIRED' | 'TICKET_INVALID' | 'TICKET_EXPIRED' | 'TICKET_USED' | 'REFRESH_TOKEN_INVALID' | 'REFRESH_TOKEN_REPLAYED' | 'REFRESH_NOT_COMMITTED' | 'PERMISSION_DENIED' | 'APP_DISABLED' | 'AGENT_DISABLED' | 'AGENT_NOT_FOUND' | 'AGENT_ALREADY_EXISTS' | 'CALL_CONTROL_REJECTED' | 'AGENT_SIP_NOT_READY' | 'AGENT_CONFLICT' | 'RATE_LIMITED' | 'INTERNAL_ERROR' | 'PROVIDER_BAD_RESPONSE' | 'SERVICE_UNAVAILABLE' | 'SIP_CREDENTIAL_UNAVAILABLE' | 'PROVIDER_TIMEOUT' | 'NOT_FOUND' | 'METHOD_NOT_ALLOWED' | 'UNSUPPORTED_MEDIA_TYPE' | 'NUMBER_UNAVAILABLE' | 'CALLEE_CALLING';
11
11
  /** SDK 本地错误码 */
12
12
  type SdkErrorCode = 'DESTROYED' | 'NOT_INITIALIZED' | 'ALREADY_INITIALIZED' | 'INITIALIZE_IN_PROGRESS' | 'INITIALIZE_FAILED' | 'NOT_AUTHENTICATED' | 'COMMAND_IN_PROGRESS' | 'NOT_REGISTERED' | 'REGISTRATION_FAILED' | 'SIGNALING_UNAVAILABLE' | 'INVALID_NUMBER' | 'INVALID_ARGUMENT' | 'CALL_IN_PROGRESS' | 'CALL_NOT_FOUND' | 'INVALID_CALL_STATE' | 'CALL_STATE_CHANGED' | 'CALL_STATE_UNKNOWN' | 'CALL_ENDED' | 'HOLD_TRANSITION_IN_PROGRESS' | 'HOLD_FAILED' | 'HOLD_TIMEOUT' | 'MEDIA_PERMISSION_DENIED' | 'MEDIA_DEVICE_UNAVAILABLE' | 'NETWORK_ERROR' | 'TIMEOUT' | 'ABORTED';
13
13
  type ErrorCode = ServerErrorCode | SdkErrorCode;
@@ -155,11 +155,13 @@ interface CallSnapshot {
155
155
  };
156
156
  readonly display?: CallDisplay;
157
157
  /**
158
- * 外呼经 AXB 分配的外显号码(WS-10):仅当业务通知的 bnumber 与本次拨打号码完全一致时写入,
159
- * 来电与未匹配的外呼不携带;更新通过同状态 call.status 发布,不改变通话状态。
158
+ * 外呼的呼叫会话标识(HTTP v0.17.0 呼前取号返回):与振铃/应答通知的 data.callSessionId 相同,
159
+ * 宿主据此判断通知是否属于本次外呼;随外呼首个快照写入且不再改变,来电不携带。
160
160
  */
161
+ readonly callSessionId?: string;
162
+ /** 外呼的外显号码(X 号码,INVITE 目标):取自呼前取号结果,随首个快照写入且不再改变;来电不携带。 */
161
163
  readonly xnumber?: string;
162
- /** 外呼 X 号码归属省区;仅省市齐全时随号码写入;同号后续缺失保留,换号且无省市时清除。 */
164
+ /** 外呼 X 号码归属省区;呼前取号同时返回省市时写入,否则与 xcity 一起缺失。 */
163
165
  readonly xprovince?: string;
164
166
  /** 外呼 X 号码归属城市;与 xprovince 成对出现。 */
165
167
  readonly xcity?: string;
@@ -180,13 +182,33 @@ interface CallSnapshot {
180
182
  */
181
183
  readonly sipStatus?: number;
182
184
  }
183
- /** 外呼可选展示信息,不作为号码路由或客户接听证据。 */
185
+ /** 外呼可选展示信息与通话记录字段,不作为号码路由或客户接听证据。 */
184
186
  interface DialOptions {
185
187
  readonly display?: CallDisplay;
188
+ /**
189
+ * 被叫姓名(HTTP v0.18.0):随呼前取号透传,写入外呼通话记录;不超过 64 个字符(按 Unicode 码点计),
190
+ * 原样提交、不裁剪。不传则正文不带、记录该列为空;不合规在本地以 INVALID_ARGUMENT reject,不发 HTTP。不影响展示。
191
+ */
192
+ readonly calleeName?: string;
193
+ /**
194
+ * 发起端(HTTP v0.18.0):'PC' 或 'APP',大小写敏感;随呼前取号透传,写入外呼通话记录。
195
+ * 不传则正文不带、记录该列为空;其他值在本地以 INVALID_ARGUMENT reject,不发 HTTP。
196
+ */
197
+ readonly source?: 'PC' | 'APP';
186
198
  }
187
199
  /** 一键拨打只等待当前在途准备,不领取 Ticket 或发起注册。 */
188
200
  interface QuickDialOptions {
189
201
  readonly display?: CallDisplay;
202
+ /**
203
+ * 被叫姓名(HTTP v0.18.0):随呼前取号透传,写入外呼通话记录;不超过 64 个字符(按 Unicode 码点计),
204
+ * 原样提交、不裁剪。不传则正文不带、记录该列为空;不合规在本地以 INVALID_ARGUMENT reject,不发 HTTP。不影响展示。
205
+ */
206
+ readonly calleeName?: string;
207
+ /**
208
+ * 发起端(HTTP v0.18.0):'PC' 或 'APP',大小写敏感;随呼前取号透传,写入外呼通话记录。
209
+ * 不传则正文不带、记录该列为空;其他值在本地以 INVALID_ARGUMENT reject,不发 HTTP。
210
+ */
211
+ readonly source?: 'PC' | 'APP';
190
212
  /** 认证中、登录连接材料 加载或注册中的等待上限,默认 10000 毫秒。 */
191
213
  readonly waitMs?: number;
192
214
  }
@@ -284,18 +306,12 @@ interface CallCenterState {
284
306
  readonly workStatus: WorkStatus | null;
285
307
  }
286
308
  type BackgroundPhase = 'refresh' | 'credentials' | 'registration' | 'signaling' | 'media';
287
- /** 通知事件类型:来源上报的三种事件原名,及 AXB 回调晚于振铃时单独推送的 AXB_BOUND。 */
288
- type NotificationEventType = 'CALL_RINGING' | 'CALL_ANSWERED' | 'EventCallCDR' | 'AXB_BOUND';
289
- /** 通知数据的来源形状:可选 X/B 号码与成对省市;xnumber 缺失与显式 null 是两种不同事实。 */
309
+ /** 通知事件类型:来源上报的事件原名。 */
310
+ type NotificationEventType = 'CALL_RINGING' | 'CALL_ANSWERED';
311
+ /** 通知数据:呼叫会话标识,与 sessionID 同值;外呼时 FS 取 SIP 头 X-Uui 第一段作为 sessionID,即呼前取号返回的 callSessionId。 */
290
312
  interface NotificationEventData {
291
- /** 来源号码;缺失时不出现,null 与空串原样保留,不补值、不推断。 */
292
- readonly xnumber?: string | null;
293
- /** AXB 回调 B 号;仅号码来自回调时出现,供匹配当前外呼的拨打号码。 */
294
- readonly bnumber?: string;
295
- /** X 号码归属省区;非空字符串,≤32 字符,省市任一非法或缺失时两项一起省略。 */
296
- readonly xprovince?: string;
297
- /** X 号码归属城市;与 xprovince 成对出现。 */
298
- readonly xcity?: string;
313
+ /** 与外呼快照 callSessionId 相同时,该通知属于这次外呼;非空,≤128 字符。 */
314
+ readonly callSessionId: string;
299
315
  }
300
316
  /**
301
317
  * 独立业务通知的来源投影(WS-01 契约补充 §3)。
@@ -316,7 +332,7 @@ interface NotificationEvent {
316
332
  readonly eventType: NotificationEventType;
317
333
  /** 来源确认接收成功时的 UTC 毫秒时刻,不保证源业务顺序 */
318
334
  readonly occurredAt: IsoDateTime;
319
- /** 可选号码段;来源未给出时整段缺失 */
335
+ /** 呼叫会话标识;来源当前始终下发,契约上仍可整段缺失 */
320
336
  readonly data?: NotificationEventData;
321
337
  }
322
338
  interface CallCenterEventMap {
@@ -450,7 +466,7 @@ interface AgentsApi {
450
466
  disable(agentId: string): Promise<AgentResource>;
451
467
  }
452
468
  /** 本 SDK 消费的后端 HTTP 契约版本(openapi-v1.yaml info.version) */
453
- declare const CONTRACT_VERSION: "0.16.0";
469
+ declare const CONTRACT_VERSION: "0.19.0";
454
470
 
455
471
  /** 宿主稳定门面;仅描述已验收能力,不从内部实现推导额外类型。 */
456
472
  interface CallCenter {
@@ -505,6 +521,11 @@ interface PanelOptions {
505
521
  readonly contactName?: string;
506
522
  /** 宿主可选展示的补充说明,不参与通话资格判断。 */
507
523
  readonly supplementaryInfo?: string;
524
+ /**
525
+ * 是否以页面顶部 toast 提示面板错误,默认开启,仅挂载时读取。
526
+ * 关闭后面板不显示任何错误提示,宿主依错误码与 sdk.error 事件自行提示。
527
+ */
528
+ readonly toast?: boolean;
508
529
  }
509
530
  /** 可在挂载后更新的展示字段;initiallyVisible 只在挂载时读取,不在此列。 */
510
531
  type PanelUpdateOptions = Partial<Pick<PanelOptions, 'contactName' | 'supplementaryInfo'>>;
package/dist/index.d.ts CHANGED
@@ -7,7 +7,7 @@
7
7
  * 错误对象与消息都已脱敏:不含 Token、密码、请求体和服务端原始报文。
8
8
  */
9
9
  /** 后端契约错误码(http-contract.md §12) */
10
- type ServerErrorCode = 'BAD_REQUEST' | 'VALIDATION_ERROR' | 'TOKEN_MISSING' | 'TOKEN_INVALID' | 'TOKEN_EXPIRED' | 'SESSION_REVOKED' | 'SESSION_EXPIRED' | 'TICKET_INVALID' | 'TICKET_EXPIRED' | 'TICKET_USED' | 'REFRESH_TOKEN_INVALID' | 'REFRESH_TOKEN_REPLAYED' | 'REFRESH_NOT_COMMITTED' | 'PERMISSION_DENIED' | 'APP_DISABLED' | 'AGENT_DISABLED' | 'AGENT_NOT_FOUND' | 'AGENT_ALREADY_EXISTS' | 'CALL_CONTROL_REJECTED' | 'AGENT_SIP_NOT_READY' | 'AGENT_CONFLICT' | 'RATE_LIMITED' | 'INTERNAL_ERROR' | 'PROVIDER_BAD_RESPONSE' | 'SERVICE_UNAVAILABLE' | 'SIP_CREDENTIAL_UNAVAILABLE' | 'PROVIDER_TIMEOUT' | 'NOT_FOUND' | 'METHOD_NOT_ALLOWED' | 'UNSUPPORTED_MEDIA_TYPE';
10
+ type ServerErrorCode = 'BAD_REQUEST' | 'VALIDATION_ERROR' | 'TOKEN_MISSING' | 'TOKEN_INVALID' | 'TOKEN_EXPIRED' | 'SESSION_REVOKED' | 'SESSION_EXPIRED' | 'TICKET_INVALID' | 'TICKET_EXPIRED' | 'TICKET_USED' | 'REFRESH_TOKEN_INVALID' | 'REFRESH_TOKEN_REPLAYED' | 'REFRESH_NOT_COMMITTED' | 'PERMISSION_DENIED' | 'APP_DISABLED' | 'AGENT_DISABLED' | 'AGENT_NOT_FOUND' | 'AGENT_ALREADY_EXISTS' | 'CALL_CONTROL_REJECTED' | 'AGENT_SIP_NOT_READY' | 'AGENT_CONFLICT' | 'RATE_LIMITED' | 'INTERNAL_ERROR' | 'PROVIDER_BAD_RESPONSE' | 'SERVICE_UNAVAILABLE' | 'SIP_CREDENTIAL_UNAVAILABLE' | 'PROVIDER_TIMEOUT' | 'NOT_FOUND' | 'METHOD_NOT_ALLOWED' | 'UNSUPPORTED_MEDIA_TYPE' | 'NUMBER_UNAVAILABLE' | 'CALLEE_CALLING';
11
11
  /** SDK 本地错误码 */
12
12
  type SdkErrorCode = 'DESTROYED' | 'NOT_INITIALIZED' | 'ALREADY_INITIALIZED' | 'INITIALIZE_IN_PROGRESS' | 'INITIALIZE_FAILED' | 'NOT_AUTHENTICATED' | 'COMMAND_IN_PROGRESS' | 'NOT_REGISTERED' | 'REGISTRATION_FAILED' | 'SIGNALING_UNAVAILABLE' | 'INVALID_NUMBER' | 'INVALID_ARGUMENT' | 'CALL_IN_PROGRESS' | 'CALL_NOT_FOUND' | 'INVALID_CALL_STATE' | 'CALL_STATE_CHANGED' | 'CALL_STATE_UNKNOWN' | 'CALL_ENDED' | 'HOLD_TRANSITION_IN_PROGRESS' | 'HOLD_FAILED' | 'HOLD_TIMEOUT' | 'MEDIA_PERMISSION_DENIED' | 'MEDIA_DEVICE_UNAVAILABLE' | 'NETWORK_ERROR' | 'TIMEOUT' | 'ABORTED';
13
13
  type ErrorCode = ServerErrorCode | SdkErrorCode;
@@ -155,11 +155,13 @@ interface CallSnapshot {
155
155
  };
156
156
  readonly display?: CallDisplay;
157
157
  /**
158
- * 外呼经 AXB 分配的外显号码(WS-10):仅当业务通知的 bnumber 与本次拨打号码完全一致时写入,
159
- * 来电与未匹配的外呼不携带;更新通过同状态 call.status 发布,不改变通话状态。
158
+ * 外呼的呼叫会话标识(HTTP v0.17.0 呼前取号返回):与振铃/应答通知的 data.callSessionId 相同,
159
+ * 宿主据此判断通知是否属于本次外呼;随外呼首个快照写入且不再改变,来电不携带。
160
160
  */
161
+ readonly callSessionId?: string;
162
+ /** 外呼的外显号码(X 号码,INVITE 目标):取自呼前取号结果,随首个快照写入且不再改变;来电不携带。 */
161
163
  readonly xnumber?: string;
162
- /** 外呼 X 号码归属省区;仅省市齐全时随号码写入;同号后续缺失保留,换号且无省市时清除。 */
164
+ /** 外呼 X 号码归属省区;呼前取号同时返回省市时写入,否则与 xcity 一起缺失。 */
163
165
  readonly xprovince?: string;
164
166
  /** 外呼 X 号码归属城市;与 xprovince 成对出现。 */
165
167
  readonly xcity?: string;
@@ -180,13 +182,33 @@ interface CallSnapshot {
180
182
  */
181
183
  readonly sipStatus?: number;
182
184
  }
183
- /** 外呼可选展示信息,不作为号码路由或客户接听证据。 */
185
+ /** 外呼可选展示信息与通话记录字段,不作为号码路由或客户接听证据。 */
184
186
  interface DialOptions {
185
187
  readonly display?: CallDisplay;
188
+ /**
189
+ * 被叫姓名(HTTP v0.18.0):随呼前取号透传,写入外呼通话记录;不超过 64 个字符(按 Unicode 码点计),
190
+ * 原样提交、不裁剪。不传则正文不带、记录该列为空;不合规在本地以 INVALID_ARGUMENT reject,不发 HTTP。不影响展示。
191
+ */
192
+ readonly calleeName?: string;
193
+ /**
194
+ * 发起端(HTTP v0.18.0):'PC' 或 'APP',大小写敏感;随呼前取号透传,写入外呼通话记录。
195
+ * 不传则正文不带、记录该列为空;其他值在本地以 INVALID_ARGUMENT reject,不发 HTTP。
196
+ */
197
+ readonly source?: 'PC' | 'APP';
186
198
  }
187
199
  /** 一键拨打只等待当前在途准备,不领取 Ticket 或发起注册。 */
188
200
  interface QuickDialOptions {
189
201
  readonly display?: CallDisplay;
202
+ /**
203
+ * 被叫姓名(HTTP v0.18.0):随呼前取号透传,写入外呼通话记录;不超过 64 个字符(按 Unicode 码点计),
204
+ * 原样提交、不裁剪。不传则正文不带、记录该列为空;不合规在本地以 INVALID_ARGUMENT reject,不发 HTTP。不影响展示。
205
+ */
206
+ readonly calleeName?: string;
207
+ /**
208
+ * 发起端(HTTP v0.18.0):'PC' 或 'APP',大小写敏感;随呼前取号透传,写入外呼通话记录。
209
+ * 不传则正文不带、记录该列为空;其他值在本地以 INVALID_ARGUMENT reject,不发 HTTP。
210
+ */
211
+ readonly source?: 'PC' | 'APP';
190
212
  /** 认证中、登录连接材料 加载或注册中的等待上限,默认 10000 毫秒。 */
191
213
  readonly waitMs?: number;
192
214
  }
@@ -284,18 +306,12 @@ interface CallCenterState {
284
306
  readonly workStatus: WorkStatus | null;
285
307
  }
286
308
  type BackgroundPhase = 'refresh' | 'credentials' | 'registration' | 'signaling' | 'media';
287
- /** 通知事件类型:来源上报的三种事件原名,及 AXB 回调晚于振铃时单独推送的 AXB_BOUND。 */
288
- type NotificationEventType = 'CALL_RINGING' | 'CALL_ANSWERED' | 'EventCallCDR' | 'AXB_BOUND';
289
- /** 通知数据的来源形状:可选 X/B 号码与成对省市;xnumber 缺失与显式 null 是两种不同事实。 */
309
+ /** 通知事件类型:来源上报的事件原名。 */
310
+ type NotificationEventType = 'CALL_RINGING' | 'CALL_ANSWERED';
311
+ /** 通知数据:呼叫会话标识,与 sessionID 同值;外呼时 FS 取 SIP 头 X-Uui 第一段作为 sessionID,即呼前取号返回的 callSessionId。 */
290
312
  interface NotificationEventData {
291
- /** 来源号码;缺失时不出现,null 与空串原样保留,不补值、不推断。 */
292
- readonly xnumber?: string | null;
293
- /** AXB 回调 B 号;仅号码来自回调时出现,供匹配当前外呼的拨打号码。 */
294
- readonly bnumber?: string;
295
- /** X 号码归属省区;非空字符串,≤32 字符,省市任一非法或缺失时两项一起省略。 */
296
- readonly xprovince?: string;
297
- /** X 号码归属城市;与 xprovince 成对出现。 */
298
- readonly xcity?: string;
313
+ /** 与外呼快照 callSessionId 相同时,该通知属于这次外呼;非空,≤128 字符。 */
314
+ readonly callSessionId: string;
299
315
  }
300
316
  /**
301
317
  * 独立业务通知的来源投影(WS-01 契约补充 §3)。
@@ -316,7 +332,7 @@ interface NotificationEvent {
316
332
  readonly eventType: NotificationEventType;
317
333
  /** 来源确认接收成功时的 UTC 毫秒时刻,不保证源业务顺序 */
318
334
  readonly occurredAt: IsoDateTime;
319
- /** 可选号码段;来源未给出时整段缺失 */
335
+ /** 呼叫会话标识;来源当前始终下发,契约上仍可整段缺失 */
320
336
  readonly data?: NotificationEventData;
321
337
  }
322
338
  interface CallCenterEventMap {
@@ -450,7 +466,7 @@ interface AgentsApi {
450
466
  disable(agentId: string): Promise<AgentResource>;
451
467
  }
452
468
  /** 本 SDK 消费的后端 HTTP 契约版本(openapi-v1.yaml info.version) */
453
- declare const CONTRACT_VERSION: "0.16.0";
469
+ declare const CONTRACT_VERSION: "0.19.0";
454
470
 
455
471
  /** 宿主稳定门面;仅描述已验收能力,不从内部实现推导额外类型。 */
456
472
  interface CallCenter {
@@ -505,6 +521,11 @@ interface PanelOptions {
505
521
  readonly contactName?: string;
506
522
  /** 宿主可选展示的补充说明,不参与通话资格判断。 */
507
523
  readonly supplementaryInfo?: string;
524
+ /**
525
+ * 是否以页面顶部 toast 提示面板错误,默认开启,仅挂载时读取。
526
+ * 关闭后面板不显示任何错误提示,宿主依错误码与 sdk.error 事件自行提示。
527
+ */
528
+ readonly toast?: boolean;
508
529
  }
509
530
  /** 可在挂载后更新的展示字段;initiallyVisible 只在挂载时读取,不在此列。 */
510
531
  type PanelUpdateOptions = Partial<Pick<PanelOptions, 'contactName' | 'supplementaryInfo'>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ztlink-imk/ztlinkcloud-agent-sdk",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "license": "UNLICENSED",
5
5
  "description": "IMK 呼叫中心坐席 SDK 加载器与公共类型:按服务端下发的地址加载 SDK 运行时",
6
6
  "type": "module",
@@ -20,7 +20,7 @@
20
20
  "./package.json": "./package.json"
21
21
  },
22
22
  "devDependencies": {
23
- "@imk/agent-core": "1.0.4"
23
+ "@imk/agent-core": "1.0.5"
24
24
  },
25
25
  "publishConfig": {
26
26
  "access": "public"