ims.bidl
16.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Copyright 2002-2014 the original author or authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// CC/LICENSE
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/******************************************
* Ims api Defines of CloudCall Platform
* CloundCall ver:2.5
*
*****************************************/
include "common.bidl"
namespace ims {
/*IMS接口，上层服务单元调用，可以做会话操作*/
class imsapi
{
/**
* 注册服务
* @param type [in] : 服务单元类型IVR or Acd
* reqid [out]: 服务单元在IMS中的标识
*
* @return 接口调用结果
*/
CcResultT Register(ServiceTypeT type,
[out] ReqIdT reqid);
/**
* 注销服务
* @param reqid [in] : 注册时得到的服务单元的标识
*
* @return 接口调用结果
*/
CcResultT UnRegister(ReqIdT reqid);
/**
* 分机注册， IMS会发送此分机的相关事件到此服务单元
* @param reqid [in] : 注册时得到的服务单元的标识
* devicenumber [in] : 分机号码
* dntyp [in] : 分机类型
*
* @return 接口调用结果
*/
CcResultT Assign(ReqIdT reqid, string devicenumber, DnTypeT type);
/**
* 分机反注册， IMS不再发送此分机的相关事件到此服务单元
* @param reqid [in] : 注册时得到的服务单元的标识
* devicenumber [in] : 分机号码
* dntyp [in] : 分机类型
*
* @return 接口调用结果
*/
CcResultT DeAssign(ReqIdT reqid, string devicenumber, DnTypeT type);
/**
* 外呼
* @param reqid [in] : 注册时得到的服务单元的标识
* srcUri [in] : 发起呼叫方(用户线，先呼通)
* destUri [in] : 外呼目标方(外线，后呼通)
* setSrcUri [in] : 设置呼叫发起方时的来电显示号码
* setDestUri [in] : 设置呼叫目标方时的来电显示号码
* timeout [in] : 外呼超时设置
* callmode [in] : 外呼模式
* sessionid [all] : 呼叫的session id.
*
* @return 接口调用结果
*/
CcResultT OutboundCall(ReqIdT reqid,
string devicenumber,
string destUri,
string setSrcUri,
string setDestUri,
int32 timeout,
CallModeT callmode,
[all] SessionIdT sessionid);
/**
* 应答
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Answer(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 挂断
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Release(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 保持
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Hold(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 挂断
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Retrieve(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 咨询
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
* destUri [in] : 被咨询方的分机号码
* setDestUri [in] : 设置被咨询方的来电显示号
*
* @return 接口调用结果
*/
CcResultT Consult(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber,
string destUri,
string setDestUri);
/**
* 咨询接回
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Reconnect(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 咨询转移
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Transfer(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 咨询会议
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT Conference(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 单步转移
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
* destUri [in] : 被转移方的分机号码
* mode [in] : 转移是否透传
* dispForCalled [in] : 主叫显示号码
*
* @return 接口调用结果
*/
CcResultT SingleStepTransfer(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber,
string destUri,
string dispForCalled);
/**
* 单步会议(这里的参数devicenumber是被操作方的分机号码哦)
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 被操作的分机号码
* srcUri [in] : 发起单步会议的分机号码
* dispForCalled [in] : 主叫显示号码
* type [in] : 单步会议的类型 ,监听，强插，监听强插
*
* @return 接口调用结果
*/
CcResultT SingleStepConference(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber,
string destUri,
string dispForCalled,
SsConferenceTypeT type);
/**
* 监听变强插
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
*
* @return 接口调用结果
*/
CcResultT SwitchListenAndIntrude(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber);
/**
* 设置随路数据
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* data [in] : 随路数据
*
* @return 接口调用结果
*/
CcResultT SetAssociateData(ReqIdT reqid,
SessionIdT sessionid,
string key,
string val);
/**
* 取随路数据
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* data [out] : 随路数据
*
* @return 接口调用结果
*/
CcResultT GetAssociateData(ReqIdT reqid,
SessionIdT sessionid,
string key,
[out] string val);
/**
* 发起路由请求
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* dest_service [in] : 目的服务的类型
* out [in] : 请求超时时间
* valid_time [in] : 设备锁定时间
* reqType [in] : 请求类型
* reqArgs [in] : 请求参数，是工号或者工号列表
* level [in] : 客户级别
* caller_uri [in] : 主叫分机号码
* callee_uri [in] : 被叫分机号码
* buffer [in] : 保留参数
* requestId [out]: 返回一个标志路由请求的ID
*
* @return 接口调用结果
*/
CcResultT RouteRequest(ReqIdT reqid,
SessionIdT sessionid,
ServiceTypeT destService,
int32 timeout,
int32 valid_time,
RouteRequestTypeT reqType,
string reqArgs,
int32 level,
string caller_uri,
string callee_uri,
string buffer,
[out] RouteRequestIDT requestId
);
/**
* 取消路由请求
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* requestId [in] : 路由请求ID
*
* @return 接口调用结果
*/
CcResultT CancelRouteRequest(ReqIdT reqid,
SessionIdT sessionid,
RouteRequestIDT requestId
);
/**
* 路由请求回复
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* requestId [in] : 路由请求ID
* result [in] : 路由请求结果
* targetUri [in] : 路由找到的分机号码
* targetAgentId [in] : 路由找到的坐席工号
*
* @return 接口调用结果
*/
CcResultT RouteRequestRespond(ReqIdT reqid,
SessionIdT sessionid,
RouteRequestIDT requestId,
RouteEventReasonT result,
string targetUri,
string targetAgentId
);
/**
* 创建Session
* @param reqid [in] : 注册时得到的服务单元的标识
* callsource [in] : freeswitch IP
* channel_id [in] : 客户对应的channel uuid
* oricalled [in] : 原始被叫
* sessionid [out] : 返回IMS创建的session id
*
* @return 接口调用结果
*/
CcResultT CreateSession(ReqIdT reqid,
string callsource,
string channel_id,
string oricalled,
[out] SessionIdT sessionid
);
/**
* 转坐席的方式
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* requestId [in] : 路由请求ID
* transType [in] : 转移类型
* @return 接口调用结果
*/
CcResultT TransferAgent(ReqIdT reqid,
SessionIdT sessionid,
RouteRequestIDT requestId,
TransferTypeT transType
);
/**
* 录音
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
* recordfile [in] : 录音文件名
* max_time [in] : 录音时长设置
* interrupt_keys [in] : 录音中断按键
*
* @return 接口调用结果
*/
CcResultT Record(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber,
string filename,
int32 maxTime,
string interruptKeys);
/**
* 发送按键
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* devicenumber [in] : 操作的分机号码
* dtmf [in] : DTMF串
*
* @return 接口调用结果
*/
CcResultT SendDTMF(ReqIdT reqid,
SessionIdT sessionid,
string devicenumber,
string dtmf);
/**
* 销毁SESSION,挂断session中所有呼叫，回收资源
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
*
* @return 接口调用结果
*/
CcResultT DestroySession(ReqIdT reqid, SessionIdT sessionid);
/**
* 查询session相关信息
* @param reqid [in] : 注册时得到的服务单元的标识
* sessionid [in] : 呼叫的sessionid
* originalAni [out]: 原始主叫
* originalDNIS [out]: 原始被叫
* callidList [out]: 呼叫列表
* deviceList [out]: 分机列表
*
* @return 接口调用结果
*/
CcResultT QuerySession(ReqIdT reqid,
SessionIdT sessionid,
[out] string originalAni,
[out] string originalDnis,
[out] CallIdListT callidList,
[out] sequence<string> deviceList);
/**
* 查询call信息
* @param reqid [in] : 注册时得到的服务单元的标识
* callid [in] : 当前的呼叫ID
* deviceani [out]: 主叫
* deviceDnis [out]: 被叫
* originalAni [out]: 原始主叫
* originalDNIS [out]: 原始被叫
* deviceList [out]: 分机列表
* sessionid [out] : 呼叫的sessionid
* fsid [out] : 呼叫的所属freeswitch
*
* @return 接口调用结果
*/
CcResultT QueryCall(ReqIdT reqid,
SessionIdT sessionid,
CallIdT callId,
[out] string deviceAni,
[out] string deviceDnis,
[out] string originalAni,
[out] string originalDnis,
[out] sequence<string> deviceList,
[out] int32 fsid);
/**
* 查询分机信息
* @param reqid [in] : 注册时得到的服务单元的标识
* device [in] : 查询的分机
* sessionid [out] : 呼叫的sessionid
* callstate [out] : 呼叫状态
* mediastate [out] : 媒体状态
*
* @return 接口调用结果
*/
CcResultT QueryDevice(ReqIdT reqid,
string device,
[out] SessionIdT sessionid,
[out] CallIdT callId,
[out] CallStateT callstate,
[out] MediaStateT mediastate);
/**
* 查询系统信息
* @param reqid [in] : 注册时得到的服务单元的标识
* sysinfo [in] : ims系统信息
*
* @return 接口调用结果
*/
CcResultT QuerySysInfo(ReqIdT reqid,
[out] SysInfoT sysinfo);
/**
* 配置动态加载
* @param type [in] : 动态加载的内容
*
* @return 接口调用结果
*/
CcResultT ReloadConfig(ConfigTypeT type);
/**
* 心跳接口
* @param reqid [in] : reqid
* @param info [in] : 备用，可空
*
* @return 接口调用结果
*/
CcResultT HeartBeat(ReqIdT reqid,
string info);
}
}