o2g-node-sdk 2.5.3 → 2.5.6
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/README.md +315 -21
- package/dist/o2g-node-sdk.js +3008 -2262
- package/dist/o2g-node-sdk.js.map +1 -1
- package/dist/types/events/chunk-eventing.d.ts.map +1 -0
- package/dist/types/events/event-dispatcher.d.ts.map +1 -0
- package/dist/types/events/event-packages.d.ts.map +1 -0
- package/dist/types/internal/o2g-application.d.ts +7 -1
- package/dist/types/internal/o2g-application.d.ts.map +1 -1
- package/dist/types/internal/rest/ccStatistics-rest.d.ts +1 -1
- package/dist/types/internal/rest/ccStatistics-rest.d.ts.map +1 -1
- package/dist/types/internal/util/logger.d.ts +3 -7
- package/dist/types/internal/util/logger.d.ts.map +1 -1
- package/dist/types/log-level.d.ts +17 -0
- package/dist/types/log-level.d.ts.map +1 -0
- package/dist/types/o2g-node-sdk.d.ts +126 -59
- package/dist/types/o2g-node-sdk.d.ts.map +1 -1
- package/dist/types/o2g-servers.d.ts +111 -0
- package/dist/types/o2g-servers.d.ts.map +1 -0
- package/dist/types/services/o2g-analytics.d.ts +70 -0
- package/dist/types/services/o2g-analytics.d.ts.map +1 -0
- package/dist/types/{o2g-cc-agent.d.ts → services/o2g-cc-agent.d.ts} +15 -11
- package/dist/types/services/o2g-cc-agent.d.ts.map +1 -0
- package/dist/types/{o2g-cc-mngt.d.ts → services/o2g-cc-mngt.d.ts} +68 -47
- package/dist/types/services/o2g-cc-mngt.d.ts.map +1 -0
- package/dist/types/{o2g-cc-pilot.d.ts → services/o2g-cc-pilot.d.ts} +7 -5
- package/dist/types/services/o2g-cc-pilot.d.ts.map +1 -0
- package/dist/types/{o2g-cc-rt.d.ts → services/o2g-cc-rt.d.ts} +7 -6
- package/dist/types/services/o2g-cc-rt.d.ts.map +1 -0
- package/dist/types/{o2g-cc-stat.d.ts → services/o2g-cc-stat.d.ts} +172 -175
- package/dist/types/services/o2g-cc-stat.d.ts.map +1 -0
- package/dist/types/{o2g-comlog.d.ts → services/o2g-comlog.d.ts} +72 -71
- package/dist/types/services/o2g-comlog.d.ts.map +1 -0
- package/dist/types/{o2g-directory.d.ts → services/o2g-directory.d.ts} +37 -42
- package/dist/types/services/o2g-directory.d.ts.map +1 -0
- package/dist/types/{o2g-eventSummary.d.ts → services/o2g-eventSummary.d.ts} +8 -9
- package/dist/types/services/o2g-eventSummary.d.ts.map +1 -0
- package/dist/types/{o2g-maint.d.ts → services/o2g-maint.d.ts} +11 -11
- package/dist/types/services/o2g-maint.d.ts.map +1 -0
- package/dist/types/{o2g-messaging.d.ts → services/o2g-messaging.d.ts} +6 -5
- package/dist/types/services/o2g-messaging.d.ts.map +1 -0
- package/dist/types/{o2g-pbx-mngt.d.ts → services/o2g-pbx-mngt.d.ts} +5 -5
- package/dist/types/services/o2g-pbx-mngt.d.ts.map +1 -0
- package/dist/types/{o2g-phone-set-prog.d.ts → services/o2g-phone-set-prog.d.ts} +5 -5
- package/dist/types/services/o2g-phone-set-prog.d.ts.map +1 -0
- package/dist/types/{o2g-routing.d.ts → services/o2g-routing.d.ts} +44 -26
- package/dist/types/services/o2g-routing.d.ts.map +1 -0
- package/dist/types/services/o2g-rsi.d.ts +164 -0
- package/dist/types/services/o2g-rsi.d.ts.map +1 -0
- package/dist/types/{o2g-telephony.d.ts → services/o2g-telephony.d.ts} +269 -238
- package/dist/types/services/o2g-telephony.d.ts.map +1 -0
- package/dist/types/{o2g-users-mngt.d.ts → services/o2g-users-mngt.d.ts} +22 -14
- package/dist/types/services/o2g-users-mngt.d.ts.map +1 -0
- package/dist/types/{o2g-users.d.ts → services/o2g-users.d.ts} +11 -8
- package/dist/types/services/o2g-users.d.ts.map +1 -0
- package/dist/types/session-monitoring-policy.d.ts +152 -0
- package/dist/types/session-monitoring-policy.d.ts.map +1 -0
- package/dist/types/subscription.d.ts +1 -1
- package/dist/types/subscription.d.ts.map +1 -1
- package/dist/types/types/telephony/call/ccd/call-profile.d.ts.map +1 -1
- package/package.json +2 -2
- package/dist/types/host.d.ts +0 -18
- package/dist/types/host.d.ts.map +0 -1
- package/dist/types/internal/events/chunk-eventing.d.ts.map +0 -1
- package/dist/types/internal/events/event-dispatcher.d.ts.map +0 -1
- package/dist/types/internal/events/event-packages.d.ts.map +0 -1
- package/dist/types/o2g-analytics.d.ts +0 -61
- package/dist/types/o2g-analytics.d.ts.map +0 -1
- package/dist/types/o2g-cc-agent.d.ts.map +0 -1
- package/dist/types/o2g-cc-mngt.d.ts.map +0 -1
- package/dist/types/o2g-cc-pilot.d.ts.map +0 -1
- package/dist/types/o2g-cc-rt.d.ts.map +0 -1
- package/dist/types/o2g-cc-stat.d.ts.map +0 -1
- package/dist/types/o2g-comlog.d.ts.map +0 -1
- package/dist/types/o2g-directory.d.ts.map +0 -1
- package/dist/types/o2g-eventSummary.d.ts.map +0 -1
- package/dist/types/o2g-maint.d.ts.map +0 -1
- package/dist/types/o2g-messaging.d.ts.map +0 -1
- package/dist/types/o2g-pbx-mngt.d.ts.map +0 -1
- package/dist/types/o2g-phone-set-prog.d.ts.map +0 -1
- package/dist/types/o2g-routing.d.ts.map +0 -1
- package/dist/types/o2g-rsi.d.ts +0 -156
- package/dist/types/o2g-rsi.d.ts.map +0 -1
- package/dist/types/o2g-telephony.d.ts.map +0 -1
- package/dist/types/o2g-users-mngt.d.ts.map +0 -1
- package/dist/types/o2g-users.d.ts.map +0 -1
- /package/dist/types/{internal/events → events}/chunk-eventing.d.ts +0 -0
- /package/dist/types/{internal/events → events}/event-dispatcher.d.ts +0 -0
- /package/dist/types/{internal/events → events}/event-packages.d.ts +0 -0
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import EventEmitter from 'events';
|
|
2
|
-
import { ForwardCondition } from '
|
|
3
|
-
import { OverflowCondition } from '
|
|
4
|
-
import { DndState } from '
|
|
5
|
-
import { Forward } from '
|
|
6
|
-
import { Overflow } from '
|
|
7
|
-
import { RoutingCapabilities } from '
|
|
8
|
-
import { RoutingState } from '
|
|
2
|
+
import { ForwardCondition } from '../types/routing/forward-condition';
|
|
3
|
+
import { OverflowCondition } from '../types/routing/overflow-condition';
|
|
4
|
+
import { DndState } from '../types/routing/dnd-state';
|
|
5
|
+
import { Forward } from '../types/routing/forward';
|
|
6
|
+
import { Overflow } from '../types/routing/overflow';
|
|
7
|
+
import { RoutingCapabilities } from '../types/routing/routing-capabilities';
|
|
8
|
+
import { RoutingState } from '../types/routing/routing-state';
|
|
9
9
|
/**
|
|
10
10
|
* The Routing service allows a user to manage forward, overflow, DoNotDisturb
|
|
11
11
|
* and activation of their remote extension device (if any). Using this service
|
|
@@ -79,8 +79,8 @@ export declare class Routing extends EventEmitter {
|
|
|
79
79
|
/**
|
|
80
80
|
* Activates the Do Not Disturb for the specified user.
|
|
81
81
|
* <p>
|
|
82
|
-
*
|
|
83
|
-
* already activated.
|
|
82
|
+
* When active, no calls are presented to the user. This method does nothing and
|
|
83
|
+
* returns `true` if the Do Not Disturb is already activated.
|
|
84
84
|
* <p>
|
|
85
85
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
86
86
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -118,7 +118,7 @@ export declare class Routing extends EventEmitter {
|
|
|
118
118
|
*/
|
|
119
119
|
getDndState(loginName?: string | null): Promise<DndState | null>;
|
|
120
120
|
/**
|
|
121
|
-
* Returns the routing capabilities
|
|
121
|
+
* Returns the routing capabilities available to the specified user.
|
|
122
122
|
* <p>
|
|
123
123
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
124
124
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -131,8 +131,9 @@ export declare class Routing extends EventEmitter {
|
|
|
131
131
|
/**
|
|
132
132
|
* Activates the remote extension device for the specified user.
|
|
133
133
|
* <p>
|
|
134
|
-
* When the remote extension
|
|
135
|
-
*
|
|
134
|
+
* When activated, the remote extension rings on incoming calls on the user's
|
|
135
|
+
* company phone. If it is already activated, this method does nothing and
|
|
136
|
+
* returns `true`.
|
|
136
137
|
* <p>
|
|
137
138
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
138
139
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -146,8 +147,8 @@ export declare class Routing extends EventEmitter {
|
|
|
146
147
|
/**
|
|
147
148
|
* Deactivates the remote extension device for the specified user.
|
|
148
149
|
* <p>
|
|
149
|
-
* When deactivated,
|
|
150
|
-
*
|
|
150
|
+
* When deactivated, the remote extension does not ring on incoming calls,
|
|
151
|
+
* but can still be used to place outgoing calls.
|
|
151
152
|
* <p>
|
|
152
153
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
153
154
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -170,10 +171,9 @@ export declare class Routing extends EventEmitter {
|
|
|
170
171
|
*/
|
|
171
172
|
getForward(loginName?: string | null): Promise<Forward | null>;
|
|
172
173
|
/**
|
|
173
|
-
* Cancels the forward for the specified user.
|
|
174
|
+
* Cancels the active forward for the specified user.
|
|
174
175
|
* <p>
|
|
175
|
-
* This method does nothing and returns `true` if there is no forward
|
|
176
|
-
* activated.
|
|
176
|
+
* This method does nothing and returns `true` if there is no forward activated.
|
|
177
177
|
* <p>
|
|
178
178
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
179
179
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -181,12 +181,15 @@ export declare class Routing extends EventEmitter {
|
|
|
181
181
|
*
|
|
182
182
|
* @param loginName the user login name
|
|
183
183
|
* @returns `true` if the operation succeeded; `false` otherwise.
|
|
184
|
+
* @see forwardOnNumber
|
|
185
|
+
* @see forwardOnVoiceMail
|
|
184
186
|
*/
|
|
185
187
|
cancelForward(loginName?: string | null): Promise<boolean>;
|
|
186
188
|
/**
|
|
187
|
-
*
|
|
189
|
+
* Activates a forward to the voice mail with the specified condition, for the specified user.
|
|
188
190
|
* <p>
|
|
189
191
|
* This method will fail and return `false` if the user does not have a voice mail.
|
|
192
|
+
* If a forward is already active, it is replaced by the new one.
|
|
190
193
|
* <p>
|
|
191
194
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
192
195
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -196,12 +199,16 @@ export declare class Routing extends EventEmitter {
|
|
|
196
199
|
* @param loginName the user login name
|
|
197
200
|
* @returns `true` if the operation succeeded; `false` otherwise.
|
|
198
201
|
* @see forwardOnNumber
|
|
202
|
+
* @see cancelForward
|
|
199
203
|
*/
|
|
200
204
|
forwardOnVoiceMail(condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
|
|
201
205
|
/**
|
|
202
|
-
*
|
|
206
|
+
* Activates a forward to the specified number, with the specified condition, for the
|
|
203
207
|
* specified user.
|
|
204
208
|
* <p>
|
|
209
|
+
* The number must be authorized by the OmniPCX Enterprise numbering policy.
|
|
210
|
+
* If a forward is already active, it is replaced by the new one.
|
|
211
|
+
* <p>
|
|
205
212
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
206
213
|
* ignored, but it is mandatory if the session has been opened by an
|
|
207
214
|
* administrator.
|
|
@@ -230,7 +237,7 @@ export declare class Routing extends EventEmitter {
|
|
|
230
237
|
*/
|
|
231
238
|
forwardOnNumber(number: string, condition: ForwardCondition, loginName?: string | null): Promise<boolean>;
|
|
232
239
|
/**
|
|
233
|
-
* Cancels the overflow for the specified user.
|
|
240
|
+
* Cancels the active overflow for the specified user.
|
|
234
241
|
* <p>
|
|
235
242
|
* This method does nothing and returns `true` if there is no overflow activated.
|
|
236
243
|
* <p>
|
|
@@ -240,6 +247,7 @@ export declare class Routing extends EventEmitter {
|
|
|
240
247
|
*
|
|
241
248
|
* @param loginName the user login name
|
|
242
249
|
* @returns `true` if the operation succeeded; `false` otherwise.
|
|
250
|
+
* @see overflowOnVoiceMail
|
|
243
251
|
*/
|
|
244
252
|
cancelOverflow(loginName?: string | null): Promise<boolean>;
|
|
245
253
|
/**
|
|
@@ -254,9 +262,12 @@ export declare class Routing extends EventEmitter {
|
|
|
254
262
|
*/
|
|
255
263
|
getOverflow(loginName?: string | null): Promise<Overflow | null>;
|
|
256
264
|
/**
|
|
257
|
-
* Activates an overflow
|
|
265
|
+
* Activates an overflow to the voice mail with the specified condition, for the
|
|
258
266
|
* specified user.
|
|
259
267
|
* <p>
|
|
268
|
+
* The overflow only applies when no forward is active. If an overflow is already
|
|
269
|
+
* active, it is replaced by the new one.
|
|
270
|
+
* <p>
|
|
260
271
|
* This method will fail and return `false` if the user does not have a voice mail.
|
|
261
272
|
* <p>
|
|
262
273
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
@@ -270,7 +281,10 @@ export declare class Routing extends EventEmitter {
|
|
|
270
281
|
*/
|
|
271
282
|
overflowOnVoiceMail(condition: OverflowCondition, loginName?: string | null): Promise<boolean>;
|
|
272
283
|
/**
|
|
273
|
-
* Gets the routing state of the specified user.
|
|
284
|
+
* Gets the complete routing state of the specified user.
|
|
285
|
+
* <p>
|
|
286
|
+
* The routing state includes the forward, overflow, Do Not Disturb and remote
|
|
287
|
+
* extension activation status in a single call.
|
|
274
288
|
* <p>
|
|
275
289
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
276
290
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -281,11 +295,15 @@ export declare class Routing extends EventEmitter {
|
|
|
281
295
|
*/
|
|
282
296
|
getRoutingState(loginName?: string | null): Promise<RoutingState | null>;
|
|
283
297
|
/**
|
|
284
|
-
*
|
|
298
|
+
* Requests a snapshot event to be fired with the current routing state of the specified user.
|
|
299
|
+
* <p>
|
|
300
|
+
* The {@link ON_ROUTING_STATE_CHANGED} event will contain the {@link RoutingState}
|
|
301
|
+
* (forward/overflow/DND state). If a second request is made while the previous one is still
|
|
302
|
+
* in progress, it has no effect.
|
|
285
303
|
* <p>
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
304
|
+
* If the session has been opened by an administrator and `loginName` is `null`, the snapshot
|
|
305
|
+
* is requested for all users. The request is immediately acknowledged but processing may take
|
|
306
|
+
* a long time if the number of users is large.
|
|
289
307
|
* <p>
|
|
290
308
|
* If the session has been opened for a user, the `loginName` parameter is
|
|
291
309
|
* ignored, but it is mandatory if the session has been opened by an
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"o2g-routing.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-routing.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAIlC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,qBAAa,OAAQ,SAAQ,YAAY;;IAGrC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,wBAAwB,2BAA2B;IAWnE;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlE;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAI5E;;;;;;;;;OASG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAI3F;;;;;;;;;;;;;;OAcG;IACG,uBAAuB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;;;;;OAaG;IACG,yBAAyB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;;;;;;OASG;IACG,UAAU,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAI1E;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,eAAe,CACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,gBAAgB,EAC3B,SAAS,GAAE,MAAM,GAAG,IAAW,GAChC,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAI5E;;;;;;;;;;;;;;;;;OAiBG;IACG,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,EAAE,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1G;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,eAAe,CAAC,SAAS,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAG3E"}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import EventEmitter from 'events';
|
|
2
|
+
import { AdditionalDigitCollectionCriteria } from '../types/rsi/add-digit-coll-criteria';
|
|
3
|
+
import { Tones } from '../types/rsi/tones';
|
|
4
|
+
import { RsiPoint } from '../types/rsi/rsi-point';
|
|
5
|
+
import { RouteSession } from '../types/rsi/route-session';
|
|
6
|
+
/**
|
|
7
|
+
* `Rsi` provides access to the RSI (Routing Service Intelligence) point features:
|
|
8
|
+
* <ul>
|
|
9
|
+
* <li>Makes route selection.</li>
|
|
10
|
+
* <li>Makes digits collection.</li>
|
|
11
|
+
* <li>Plays voice guides or tones.</li>
|
|
12
|
+
* <li>Plays announcements (prompts and/or digits).</li>
|
|
13
|
+
* </ul>
|
|
14
|
+
* <p>
|
|
15
|
+
* To be able to receive route requests from the OmniPCX Enterprise, the application
|
|
16
|
+
* must first subscribe to RSI events and then enable the RSI point.
|
|
17
|
+
* <p>
|
|
18
|
+
* Using this service requires having a <b>CONTACTCENTER_RSI</b> license.
|
|
19
|
+
*/
|
|
20
|
+
export declare class Rsi extends EventEmitter {
|
|
21
|
+
#private;
|
|
22
|
+
/**
|
|
23
|
+
* Raised when a digit collection session has ended.
|
|
24
|
+
* @event
|
|
25
|
+
*/
|
|
26
|
+
static readonly ON_DIGIT_COLLECTED = "OnDigitCollected";
|
|
27
|
+
/**
|
|
28
|
+
* Raised from an RSI point when a tone generation starts.
|
|
29
|
+
* @event
|
|
30
|
+
*/
|
|
31
|
+
static readonly ON_TONE_GENERATED_START = "OnToneGeneratedStart";
|
|
32
|
+
/**
|
|
33
|
+
* Raised from an RSI point when a tone generation stops.
|
|
34
|
+
* @event
|
|
35
|
+
*/
|
|
36
|
+
static readonly ON_TONE_GENERATED_STOP = "OnToneGeneratedStop";
|
|
37
|
+
/**
|
|
38
|
+
* Raised from a routing point to close a route session (the routing Crid is no longer valid).
|
|
39
|
+
* @event
|
|
40
|
+
*/
|
|
41
|
+
static readonly ON_ROUTE_END = "OnRouteEnd";
|
|
42
|
+
/**
|
|
43
|
+
* Raised from a routing point to request a route selection.
|
|
44
|
+
* @event
|
|
45
|
+
*/
|
|
46
|
+
static readonly ON_ROUTE_REQUEST = "OnRouteRequest";
|
|
47
|
+
/**
|
|
48
|
+
* Gets the configured RSI points.
|
|
49
|
+
*
|
|
50
|
+
* @returns the list of {@link RsiPoint} objects representing all declared RSI points, or `null` in case of error.
|
|
51
|
+
*/
|
|
52
|
+
getRsiPoints(): Promise<RsiPoint[] | null>;
|
|
53
|
+
/**
|
|
54
|
+
* Enables the specified RSI point.
|
|
55
|
+
*
|
|
56
|
+
* @param rsiNumber the RSI point extension number
|
|
57
|
+
* @param backup `true` to enable the RSI point in backup mode
|
|
58
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
59
|
+
*/
|
|
60
|
+
enableRsiPoint(rsiNumber: string, backup?: boolean): Promise<boolean>;
|
|
61
|
+
/**
|
|
62
|
+
* Disables the specified RSI point.
|
|
63
|
+
*
|
|
64
|
+
* @param rsiNumber the RSI point extension number
|
|
65
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
66
|
+
*/
|
|
67
|
+
disableRsiPoint(rsiNumber: string): Promise<boolean>;
|
|
68
|
+
/**
|
|
69
|
+
* Starts a digits collection on the specified RSI point, for the specified call.
|
|
70
|
+
*
|
|
71
|
+
* @param rsiNumber the RSI point extension number
|
|
72
|
+
* @param callRef the call reference
|
|
73
|
+
* @param numChars the optional number of digits to collect; the digit collection stops when this number is reached
|
|
74
|
+
* @param flushChar the optional character that stops the digit collection when pressed
|
|
75
|
+
* @param timeout the optional timeout in seconds; the digit collection stops when this delay elapses
|
|
76
|
+
* @param additionalCriteria extension criteria used to collect digits
|
|
77
|
+
* @returns a unique identifier (Crid) for this digit collection session, or `null` in case of error.
|
|
78
|
+
* @see {@link ON_DIGIT_COLLECTED} event
|
|
79
|
+
* @see {@link stopCollectDigits}
|
|
80
|
+
*/
|
|
81
|
+
startCollectDigits(rsiNumber: string, callRef: string, numChars: number, flushChar?: string | null, timeout?: number | null, additionalCriteria?: AdditionalDigitCollectionCriteria | null): Promise<boolean | null>;
|
|
82
|
+
/**
|
|
83
|
+
* Stops the specified digits collection on the specified RSI point.
|
|
84
|
+
*
|
|
85
|
+
* @param rsiNumber the RSI point extension number
|
|
86
|
+
* @param collCrid the digit collection identifier returned by {@link startCollectDigits}
|
|
87
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
88
|
+
* @see {@link startCollectDigits}
|
|
89
|
+
*/
|
|
90
|
+
stopCollectDigits(rsiNumber: string, collCrid: string): Promise<boolean>;
|
|
91
|
+
/**
|
|
92
|
+
* Plays the specified tone on the specified call.
|
|
93
|
+
*
|
|
94
|
+
* @param rsiNumber the RSI point extension number
|
|
95
|
+
* @param callRef the call reference
|
|
96
|
+
* @param tone the tone to play
|
|
97
|
+
* @param duration the duration the tone is played, in seconds
|
|
98
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
99
|
+
* @see {@link ON_TONE_GENERATED_START} event
|
|
100
|
+
* @see {@link cancelTone}
|
|
101
|
+
*/
|
|
102
|
+
playTone(rsiNumber: string, callRef: string, tone: Tones, duration: number): Promise<boolean>;
|
|
103
|
+
/**
|
|
104
|
+
* Cancels the tone currently playing on the specified call.
|
|
105
|
+
*
|
|
106
|
+
* @param rsiNumber the RSI point extension number
|
|
107
|
+
* @param callRef the call reference
|
|
108
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
109
|
+
* @see {@link ON_TONE_GENERATED_STOP} event
|
|
110
|
+
* @see {@link playTone}
|
|
111
|
+
*/
|
|
112
|
+
cancelTone(rsiNumber: string, callRef: string): Promise<boolean>;
|
|
113
|
+
/**
|
|
114
|
+
* Plays the specified voice guide on the specified call.
|
|
115
|
+
*
|
|
116
|
+
* @param rsiNumber the RSI point extension number
|
|
117
|
+
* @param callRef the call reference
|
|
118
|
+
* @param guideNumber the voice guide number as defined in the OmniPCX Enterprise
|
|
119
|
+
* @param duration an optional duration for the voice guide, in seconds
|
|
120
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
121
|
+
* @see {@link ON_TONE_GENERATED_START}
|
|
122
|
+
*/
|
|
123
|
+
playVoiceGuide(rsiNumber: string, callRef: string, guideNumber: number, duration?: number | null): Promise<boolean>;
|
|
124
|
+
/**
|
|
125
|
+
* Ends a route session, indicating that no route will be selected.
|
|
126
|
+
*
|
|
127
|
+
* @param rsiNumber the RSI point extension number
|
|
128
|
+
* @param routeCrid the routing session unique identifier
|
|
129
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
130
|
+
* @see {@link ON_ROUTE_REQUEST} event
|
|
131
|
+
*/
|
|
132
|
+
routeEnd(rsiNumber: string, routeCrid: string): Promise<boolean>;
|
|
133
|
+
/**
|
|
134
|
+
* Selects a route as a response to a route request.
|
|
135
|
+
* <p>
|
|
136
|
+
* `callingLine` can be used to change the identity of the calling number presented to the called party.
|
|
137
|
+
*
|
|
138
|
+
* @param rsiNumber the RSI point extension number
|
|
139
|
+
* @param routeCrid the routing session unique identifier
|
|
140
|
+
* @param selectedRoute the selected route number
|
|
141
|
+
* @param callingLine an optional calling line number that will be presented to the selected route
|
|
142
|
+
* @param associatedData optional correlator data to attach to the call
|
|
143
|
+
* @param routeToVoiceMail `true` if the selected route is the voice mail; `false` otherwise
|
|
144
|
+
* @returns `true` in case of success; `false` otherwise.
|
|
145
|
+
* @see {@link ON_ROUTE_REQUEST} event
|
|
146
|
+
*/
|
|
147
|
+
routeSelect(rsiNumber: string, routeCrid: string, selectedRoute: string, callingLine?: string | null, associatedData?: string | null, routeToVoiceMail?: boolean | null): Promise<boolean>;
|
|
148
|
+
/**
|
|
149
|
+
* Gets the list of existing route sessions for the specified RSI point.
|
|
150
|
+
*
|
|
151
|
+
* @param rsiNumber the RSI point extension number
|
|
152
|
+
* @returns the list of {@link RouteSession} objects representing the route sessions in progress, or `null` in case of error.
|
|
153
|
+
*/
|
|
154
|
+
getRouteSessions(rsiNumber: string): Promise<RouteSession[] | null>;
|
|
155
|
+
/**
|
|
156
|
+
* Returns the specified route session.
|
|
157
|
+
*
|
|
158
|
+
* @param rsiNumber the RSI point extension number
|
|
159
|
+
* @param routeCrid the routing session unique identifier
|
|
160
|
+
* @returns the {@link RouteSession} object on success; `null` in case of error or if no such route session exists.
|
|
161
|
+
*/
|
|
162
|
+
getRouteSession(rsiNumber: string, routeCrid: string): Promise<RouteSession | null>;
|
|
163
|
+
}
|
|
164
|
+
//# sourceMappingURL=o2g-rsi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"o2g-rsi.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-rsi.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,iCAAiC,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAS3C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,qBAAa,GAAI,SAAQ,YAAY;;IAGjC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,sBAAsB;IAExD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,uBAAuB,0BAA0B;IAEjE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,yBAAyB;IAE/D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,gBAAgB;IAE5C;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,oBAAoB;IAiBpD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC;IAIhD;;;;;;OAMG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlF;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1D;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAM,GAAG,IAAW,EAC/B,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,kBAAkB,GAAE,iCAAiC,GAAG,IAAW,GACpE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAI1B;;;;;;;OAOG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInG;;;;;;;;OAQG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;OASG;IACG,cAAc,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,QAAQ,GAAE,MAAM,GAAG,IAAW,GAC/B,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;OAOG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACG,WAAW,CACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,WAAW,GAAE,MAAM,GAAG,IAAW,EACjC,cAAc,GAAE,MAAM,GAAG,IAAW,EACpC,gBAAgB,GAAE,OAAO,GAAG,IAAW,GACxC,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIzE;;;;;;OAMG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAG5F"}
|