增加
场景描述
调用该接口增加VDN。
接口方法
该接口仅支持POST方法，不支持GET、PUT和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/sys/vdn?vdnId=xx&vdnGroupId=xx
其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。
URI中携带的参数说明如表1所示。
日志中的方法名
addVdn
请求消息
- 消息头
表2 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式，缺省值：application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
- 请求消息示例
表3 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
vdnSetup
object
True
VDN设置。
该对象的参数说明请参见表4。
2
vdnInfo
object
False
VDN基本信息。
该对象的参数说明请参见表7。
3
vdnAuthPwd
string
False
VDN对接密码
表4 vdnSetup对象参数说明 序号
名称
参数类型
是否必选
说明
1.1
accessCodes
array
False
系统接入码。
1.2
administratorWorkNo
number
True
VDN管理员。
1.3
administratorPassword
string
False
VDN管理员密码，只用于VDN设置。
密码有效期时间默认为90天。
当safeLevel不传或者传值为1的话，administratorPassword为必选值。
其密码规则为：最小长度为6，同时有字母、数字加特殊字符。
1.4
allowedAgentNum
number
False
同时签入的最大业务代表数。
取值范围为1～20000。
默认值为4。
1.5
allowedVideoAgentNum
number
False
同时签入的最大视频业务代表数。
取值范围为0～20000。
默认值为0。
1.6
allowedObsCallNum
number
False
最大并发OutBound呼出数。
取值范围为0～65535。
默认值为1000。
1.7
allowedPstnCallNum
number
False
并发语音最大呼叫数。
取值范围为1～60000。
默认值为10。
1.8
allowedIVRVideoCallNum
number
False
最大并发IVR视频呼叫数
取值范围0-100000。
默认值4。
1.9
allowedCloudVcChannelNum
number
False
并发CloudVC视频通道数
取值范围0-50000。
默认值4。
1.10
allowedIVRCallNum
number
False
并发IVR最大呼叫数
取值范围为0-100000
默认值为0。
1.11
ivrIds
array
False
IVR。
1.12
isAllowedChangePassword
number
False
是否允许修改业务代表密码。
- 0：否
- 1：是
默认值为0。
1.13
isAllowedWebCall
number
False
是否允许Web呼叫。
- 0：否
- 1：是
默认值为0。
1.14
minPasswordAvailableTime
number
False
密码最短有效期。
取值范围为0～1440。
默认值为5。
1.15
minPasswordLength
number
False
业务代表最小密码长度。
取值范围为1～8。
当safeLevel不传或者传值为1的话，默认值为8。当safeLevel传值为0的话，默认值为6。
1.16
modifyPasswordAfterInit
number
False
启用密码初始化后下次登录是否必须修改。
- 0：否
- 1：是
说明：设置为0有安全风险，请谨慎使用，建议使用1，表示下次登录必须修改密码。
1.17
prePromptTime
number
False
密码过期前多久提示。
取值范围为1～15。
默认值为15。
1.18
supportDouble
number
False
录音特性。
- 1：启动双录音，任何一方成功就算成功，两方都失败才算失败。
- 2：启动双录音，VP成功才算成功。
- 3：启动双录音，外部录音成功才算成功。
- 4：启动双录音，两方都成功才算成功,有一个失败就算失败。
默认值为1。
1.19
safeLevel
number
False
安全级别。
- 0：低
- 1：高
默认值为1。
说明：安全级别设置为0有安全风险，请谨慎使用，建议使用默认值。
1.20
vdnEnabled
number
False
启用禁用VDN。
- 0：禁止使用
- 1：允许使用
默认值为1
1.21
vdnName
string
True
VDN名称。
最大长度为20字节，不含"[]'&()=;<>,特殊字符
1.22
workNoScopes
array
False
工号范围。
请参见表5。
1.23
obsId
number
False
OBS编号。
说明：在vdn的增加接口中，如果携带obsId，当obsInterfaceType为2时，则obsUrlId不能为null；obsInterfaceType不为2时，则obsDbSourceId不能为null。且obsId与obsDbSourceId、obsUrlId不能为0
1.24
obsDbSourceId
number
False
OBS数据源。
1.25
obsDbSource2Id
number
False
OBS数据源2。
1.26
obsInterfaceType
number
False
OBS接口类型。
- 0：数据库
- 1：API
- 2：http或https协议
默认值为0。组网为全容器化时只支持0。其他组网支持0、2.
说明：http协议为不安全的协议，有安全风险，建议使用安全的https协议。
1.27
obsProcName
string
False
取协议版本号存储过程。
最大长度为50字节。
默认值为：spHuaweiGetOutBoundPVersion。
1.28
isLimitCalloutNoPrefix
number
False
限制VDN主叫号码。
- 0：否
- 1：是
默认值为1。
1.29
vdnLimitedCalloutNoPrefixList
array
False
可用的主叫号码前缀。
取值类型为数组。
主叫号码前缀数组最大长度100。
单个主叫号码前缀长度为24。
单个主叫号码前缀取值为0123456789*#。
1.30
recordFileDisks
array[string]
False
自录音盘符。
1.31
unLockTime
number
False
锁定后解锁时间，单位：分。
范围：1-86400
默认值10。
1.32
mediaAgentChn
array
False
多媒体渠道配置，字段说明如表6所示。
1.33
resGroupId
number
False
CSS资源组编号。cti模式为single时，不携带此参数
1.34
vdnVideoMode
number
False
视频应用模式。
- 0：SFU(UAP)
- 1：MCU(CloudVC）
- 2：MCU(CloudVC)+SFU
- 3：MCU(UAP)
默认值为0。
1.35
allowedUapConfVideoCallNum
number
False
UAP视频会场方数。
- 当vdnVideoMode为3时该参数才生效。租间的allowedUapConfVideoCallNum最大不超过CTI license申请的UAP视频会场方数，且租间可配置范围：allowedUapConfVideoCallNum = CTI license申请的UAP视频会场方数 - 其余租间allowedUapConfVideoCallNum之和。
- 当vdnVideoMode不为3时，allowedUapConfVideoCallNum为0。
1.36
allowedTTSAndASRCallNum
int
false
智能IVR通道数，默认值10，值域范围：0~65535。
1.37
ccdisId
int
false
CCDIS编号，默认值为0，表示不配置。
1.38
retryTimes
number
False
座席最大尝试登陆次数
1.39
allowedWebCallNum
number
False
并发Web最大呼叫数
取值范围为1～20000。
1.40
obsUrlId
number
False
OBS URL ID，obsInterfaceType为2时，必传。
1.41
mediaChanTotalCallNum
number
False
VDN级座席多媒体全渠道总并发数
取值范围：[0,60]
cti默认是0
0表示不限制全渠道总并发数
不传表示不限制全渠道总并发数
1.42
virtualCallInDetectConfigMode
int
false
ACD检测开启模式，取值范围：
- 0：根据系统配置，默认值
- 1：开启检测，
- 2：关闭检测
表5 workNoScopes对象数组参数说明 序号
名称
参数类型
是否必选
说明
1.22.1
workNoStart
number
True
起始工号。
1.22.2
workNoEnd
number
True
结束工号。
表6 mediaAgentChn多媒体渠道配置 序号
名称
参数类型
是否必选
说明
1.32.1
chnType
number
True
渠道类型
50：eMail chat
51：web Chat
52：SMS
53：多媒体渠道Social Chat
54：Fax
55：H5 Video
1.32.2
agentNum
number
True
同时签入的最大多媒体业务代表数。
1.32.3
mmCallNum
number
False
座席能够同时处理的多媒体并发呼叫数，默认为5。
渠道类型为 55 （H5 Video）时并发数只能为1。
表7 vdnInfo对象参数说明 序号
名称
参数类型
是否必选
说明
2.1
accessCodes
array
False
系统接入码。
2.2
allowDrvPlayQueueVoice
number
False
排队处理时是否收号。
- 0：放排队音时不收号
- 1：放排队音时收号
默认值为0。
2.3
allowedAgentRestMaxNum
number
False
所有队列最大允许休息人数。
取值范围1~1000。
默认值为1000。
2.4
callDispatchBySkillModel
number
False
呼叫分配方式。
- 0：技能最佳分配
- 1：平均分配
- 2：技能多者优先分配
默认值为0。
2.5
dialupRouteStrategy
number
False
收号信息路由策略。
- 0：使用呼入被叫 + 收号信息路由
- 1：使用匹配呼叫 + 收号信息路由
默认值为0。
2.6
flowFilePath
string
False
流程文件存放路径。
最大长度为255字节。
2.7
forceVdnSelfRecord
number
False
VDN强制自录制。
- 0：禁用
- 1：对所有话务员启用
- 2：由质检员选择话务员启用
- 3：按百分比录制
默认值为1。
2.8
selfRecordMediaType
number
False
录制的媒体类型。
- 0：只录音频
- 1：录制音频和视频
默认值为0。
2.9
recordVideoFormat
number
False
录制的视频文件格式。
- 0：视频缺省文件格式，在录音资源侧配置
- 1：AVI格式
- 2：3GP格式
默认值为0。
2.10
ifCancelBusyWhenCallOut
number
False
0退出示忙,
1保持示忙
默认值为0。
2.11
queueCancelKey
string
False
取消排队键。
最大长度为1字节。
可取值为0123456789*#。
2.12
recordFormateOki
number
False
CP台会场录音格式。
- 0：缺省格式，可在CP台配置
- 2：24K VOX
- 8：32K VOX
- 16：64K Alaw
默认值为0。
2.13
systemAni
string
True
系统主叫号码。
可取值为0123456789*#。最大长度24字节。
2.14
vpLang
number
False
VP音报工号语种。
- 0：普通话
- 1：英语
- 2：方言1
- 3：方言2
默认值为0。
2.15
singlePhoneDisplayedNo
number
False
单电话座席来电显示。
- 0：系统主叫
- 1：客户号码
默认值为0。
2.16
pcPhoneDisplayNo
number
False
PC+PHONE座席电话来电显示。
- 0：系统主叫
- 1：客户号码
默认值为0。
2.17
ifBusyNoAnswerAgent
number
False
座席久不应答座席是否示忙。
2.18
asrGramFile
string
False
识别语法文件。当配置为智能识别的时候，必须增加此字段。
最大长度127字节，不含特殊字符。
默认值为：y:/dgnlr.grxml。
2.19
language
number
False
识别语种。
2.20
timeZone
string
False
vdn所在的时区。当为空白字符串时，表示使用配置提交时的系统默认时区。
2.21
dstEnable
number
False
是否启用夏令时，默认值为0。南半球夏令时结束时间可能小于开始时间，需调用方保证夏令时结束时间正确性。
0：不启用，1启用
2.22
dstOffsetTime
number
False
夏令时偏移时间（单位：分钟），取值范围 为[-1440,1440]，默认值为0。
2.23
dstStartMonth
number
False
夏令时开始月份，默认值为3。
2.24
dstStartIndex
number
False
夏令时开始周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。
2.25
dstStartWeekDay
number
False
夏令时开始星期，默认值为1。1：星期天，2：星期1,...7：星期6。
2.26
dstStartTime
string
False
夏令时开始时间点，此时间为本地非夏令时时间，默认值为 "00:00"。
2.27
dstEndMonth
number
False
夏令时结束月份，默认值为10。
2.28
dstEndIndex
number
False
夏令时结束周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。
2.29
dstEndWeekDay
number
False
夏令时结束星期，默认值为1。1：星期天，2：星期1,...7：星期6。
2.30
dstEndTime
string
False
夏令时结束时间点，此时间为本地非夏令时时间，默认值为 "00:00"。
2.31
multiMediaSynFlag
number
False
租户支持业务代表同时处理多种媒体呼叫
1：开启
0：不开启
缺省值：0
2.32
recordRuleId
string
False
H5视频录制规则Id，最大长度11
说明：参数已废弃调用接口时无需传参。
2.33
recordPath
string
False
H5视频录制文件存储路径，最大长度255
说明：参数已废弃调用接口时无需传参。
2.34
screenshotRuleId
string
False
H5视频截图规则Id，最大长度11
说明：参数已废弃调用接口时无需传参。
2.35
screenshotPath
string
False
H5视频截图文件存储路径，最大长度255
说明：参数已废弃调用接口时无需传参。
2.36
virtualCallInDetectFlag
int
False
外呼是否启动ACD检测，取值范围：
- 0：不启动检测
- 1：接通前启动检测
- 2：接通后启动检测
2.37
virtualCallInDetectType
int
False
外呼检测开启方式，取值范围：
- 0：按VDN开启
- 1：按OBS任务开启
2.38
waitDetectResTime
int
False
外呼等待检测结果时长(s)，取值范围：1~20
2.39
detectResProMode
int
False
外呼收到非人工应答检测结果处理方式，取值范围：
- 0：释放
- 1：接通
2.40
detectTimeOutProMode
int
False
外呼等待检测结果超时处理方式，取值范围：
- 0：释放
- 1：接通
2.41
supportEncryptRecord
int
False
是否开启录音文件加密，取值范围：
- 1：是
- 0：否
2.42
agentRecordKeyScene
string
False
进行录音文件加密时，kms密钥的scene
2.43
agentRecordKeyAlias
string
False
进行录音文件加密时，kms密钥的alias
2.44
ivrRecordKeyScene
string
False
进行IVR录音文件加密时，kms密钥的scene
2.45
ivrRecordKeyAlias
string
False
进行IVR录音文件加密时，kms密钥的alias
2.46
supportScreenRecordEncrypt
int
False
是否开启录屏文件加密，取值范围：
- 1：是
- 0：否
2.47
screenRecordKeyScene
string
False
进行录屏文件加密时，kms密钥的scene
2.48
screenRecordKeyAlias
string
False
进行录屏文件加密时，kms密钥的alias
响应消息
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "vdnSetup": { "ccdisId":0, "accessCodes": [ "789654" ], "administratorWorkNo": 30000, "administratorPassword": "********", "allowedPstnCallNum": 10, "allowedIVRCallNum": 4, "allowedCloudVcChannelNum": 24, "allowedIVRVideoCallNum": 10, "allowedUapConfVideoCallNum": 0, "vdnName": "vdntest", "unLockTime": 15, "isAllowedWebCall": 1, "vdnVideoMode": 1, "mediaAgentChn": [ { "chnType": 53, "agentNum": 2, "mmCallNum": 23 } ], "workNoScopes": [ { "workNoStart": 29999, "workNoEnd": 30010 } ], "obsId": 1, "obsDbSourceId": 1, "obsDbSource2Id": 2, "obsInterfaceType": 1, "mediaChanTotalCallNum": 10, "obsProcName": "wwww" }, "vdnInfo": { "ifCancelBusyWhenCallOut": 1, "singlePhoneDisplayedNo": 1, "systemAni": "123", "recordFormateOki": 0, "vpLang": 0, "flowFilePath": "C:\\", "queueCancelKey": "*", "allowedAgentRestMaxNum": 1, "pcPhoneDisplayNo": 1, "accessCodes": [ "789654" ], "selfRecordMediaType": 0, "forceVdnSelfRecord": 0, "ifBusyNoAnswerAgent": 1, "callDispatchBySkillModel": 0, "allowDrvPlayQueueVoice": 0, "recordVideoFormat": 0, "dialupRouteStrategy": 0, "timeZone": "+08:00", "dstEnable": 0, "dstOffsetTime": 1440, "dstStartMonth": 6, "dstStartIndex": 1, "dstStartWeekDay": 1, "dstStartTime": "06:00", "dstEndMonth": 9, "dstEndIndex": 4, "dstEndWeekDay": 7, "dstEndTime": "20:00", "multiMediaSynFlag": 0 } } - 响应参数
{ "result": { "vdnId": 31 }, "message": "success", "retcode": "0" }
