查询_VDN_系统配置接口说明_CC-Gateway 配置接口参考_API参考

场景描述

调用该接口查询VDN。

接口方法

该接口仅支持GET方法，不支持PUT、POST和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/config/sys/vdn?ids=5,4

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。

URI中携带的参数说明如表1所示。

表1 URI中携带的参数说明
序号	名称	参数类型	是否必选	说明
1	ids	string	False	需要查询的VDN编号列表。为空时，表示查询所有VDN的数据。查询多个VDN时，以“,”逗号分隔，一次最多不超过100个。

日志中的方法名

queryVdn

请求消息

消息头

表2 消息头参数说明
序号	名称	参数类型	是否必选	说明
1	Content-Type	string	True	消息主体编码方式，缺省值：application/json; charset=UTF-8
2	Guid	string	True	Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

响应消息

表3 消息体参数说明
序号	参数名	数据类型	说明
1	message	string	返回消息
2	retcode	string	操作的结果原因码。取值类型为整数。 0：成功非0：失败，具体见“错误码定义”章节
3	result	array	返回结果。该数组中的对象参数说明请参见表4。

表4 result数组对象参数
序号	名称	参数类型	说明
3.1	vdnId	number	VDN编号
3.2	data	object	VDN信息。该对象参数说明请参见表5。

表5 data VDN信息对象
序号	名称	参数类型	说明
3.2.1	vdnSetup	object	VDN设置。该对象的参数说明请参见表6。
3.2.2	vdnInfo	object	VDN基本信息。该对象的参数说明请参见表9。
3.2.3	parentGroupId	number	父vdn组id。

表6 vdnSetup对象参数说明
序号	名称	参数类型	说明
3.2.1.1	accessCodes	array	系统接入码。
3.2.1.2	administratorWorkNo	number	VDN管理员。
3.2.1.3	administratorPassword	string	VDN管理员密码，只用于VDN设置。
3.2.1.4	allowedAgentNum	number	同时签入的最大业务代表数。取值范围为1～20000。默认值为4。
3.2.1.5	allowedVideoAgentNum	number	同时签入的最大视频业务代表数。取值范围为0～20000。默认值为0。
3.2.1.6	allowedObsCallNum	number	最大并发OutBound呼出数。取值范围为0～65535。默认值为1000。
3.2.1.7	allowedPstnCallNum	number	并发语音最大呼叫数。取值范围为1～60000。默认值为10。
3.2.1.8	allowedIVRVideoCallNum	number	最大并发IVR视频呼叫数取值范围0-100000。默认值4。
3.2.1.9	allowedCloudVcChannelNum	number	并发CloudVC视频通道数取值范围0-50000。默认值4。
3.2.1.10	allowedIVRCallNum	number	并发IVR最大呼叫数取值范围为0-100000 默认值为0。
3.2.1.11	ivrIds	array	IVR。
3.2.1.12	isAllowedChangePassword	number	是否允许修改业务代表密码。 0：否 1：是默认值为0。
3.2.1.13	isAllowedWebCall	number	是否允许Web呼叫。 0：否 1：是默认值为0。
3.2.1.14	minPasswordAvailableTime	number	密码最短有效期。取值范围为0～1440。默认值为5。
3.2.1.15	minPasswordLength	number	业务代表最小密码长度。取值范围为1～6。默认值为6。
3.2.1.16	modifyPasswordAfterInit	number	启用密码初始化后下次登录是否必须修改。 0：否 1：是默认值为0。
3.2.1.17	prePromptTime	number	密码过期前多久提示。取值范围为1～15。默认值为15。
3.2.1.18	supportDouble	number	录音特性。 1：启动双录音，任何一方成功就算成功，两方都失败才算失败。 2：启动双录音，VP成功才算成功。 3：启动双录音，外部录音成功才算成功。 4：启动双录音，两方都成功才算成功,有一个失败就算失败。默认值为1。
3.2.1.19	safeLevel	number	安全级别。 0：低 1：高默认值为1。
3.2.1.20	vdnEnabled	number	启用禁用VDN。 0：禁止使用 1：允许使用默认值为1
3.2.1.21	vdnName	string	VDN名称。最大长度为20字节。
3.2.1.22	workNoScopes	array	工号范围。请参见表7。
3.2.1.23	obsId	number	OBS编号。
3.2.1.24	obsDbSourceId	number	OBS数据源。
3.2.1.25	obsDbSource2Id	number	OBS数据源2。
3.2.1.26	obsInterfaceType	number	OBS接口类型。 0：数据库 1：API 2：http或https协议默认值为0。目前只支持0、2。说明： http协议味不安全的协议，有安全风险，建议使用安全的https协议。
3.2.1.27	obsProcName	string	取协议版本号存储过程。最大长度为50字节。默认值为：spHuaweiGetOutBoundPVersion。
3.2.1.28	isLimitCalloutNoPrefix	number	限制VDN主叫号码。 0：否 1：是默认值为1。
3.2.1.29	vdnLimitedCalloutNoPrefixList	array	可用的主叫号码前缀。取值类型为数组。主叫号码前缀数组最大长度100。单个主叫号码前缀长度为24。单个主叫号码前缀取值为0123456789*#。
3.2.1.30	recordFileDisks	array[string]	自录音盘符。
3.2.1.31	unLockTime	number	锁定后解锁时间，单位：分。范围：1-86400。默认值10。
3.2.1.32	mediaAgentChn	array	多媒体渠道配置，字段说明如表8所示。
3.2.1.33	resGroupId	number	CSS资源组编号。
3.2.1.34	vdnVideoMode	number	视频应用模式。 0：SFU(UAP) 1：MCU(CloudVC） 2：MCU(CloudVC)+SFU 3：MCU(UAP) 默认值为0。
3.2.1.35	allowedUapConfVideoCallNum	number	UAP视频会场方数。当vdnVideoMode为3时该参数才生效。租间的allowedUapConfVideoCallNum最大不超过CTI license申请的UAP视频会场方数，且租间可配置范围：allowedUapConfVideoCallNum = CTI license申请的UAP视频会场方数 - 其余租间allowedUapConfVideoCallNum之和。当vdnVideoMode不为3时，allowedUapConfVideoCallNum为0。
3.2.1.36	allowedTTSAndASRCallNum	int	智能IVR通道数，默认值10，值域范围：0~65535。
3.2.1.37	ccdisId	int	CCDIS编号，默认值为0，表示不配置。
3.2.1.38	allowedWebCallNum	number	并发Web最大呼叫数取值范围为1～20000。
3.2.1.39	obsUrlId	number	OBS URL ID，obsInterfaceType为2时，必传。
3.2.1.40	mediaChanTotalCallNum	number	VDN级座席多媒体全渠道总并发数，取值范围：[0,60] 0表示不限制全渠道总并发数不传表示不限制全渠道总并发数 CTI默认是0
3.2.1.41	virtualCallInDetectConfigMode	int	ACD检测开启模式，取值范围： 0：根据系统配置，默认值 1：开启检测， 2：关闭检测

表7 workNoScopes对象数组参数说明
序号	名称	参数类型	说明
3.2.1.22.1	workNoStart	number	起始工号。
3.2.1.22.2	workNoEnd	number	结束工号。

表8 mediaAgentChn多媒体渠道配置
序号	名称	参数类型	说明
3.2.1.32.1	chnType	number	渠道类型。 50：eMail chat 51：web Chat 52：SMS 53：多媒体渠道Social Chat 54：Fax 55：H5 Video
3.2.1.32.2	agentNum	number	同时签入的最大多媒体业务代表数。
3.2.1.32.3	mmCallNum	number	座席能够同时处理的多媒体并发呼叫数，默认为5，目前暂不支持查询出结果。

表9 vdnInfo对象参数说明
序号	名称	参数类型	说明
3.2.2.1	accessCodes	array	系统接入码。
3.2.2.2	allowDrvPlayQueueVoice	number	排队处理时是否收号。 0：放排队音时不收号 1：放排队音时收号默认值为0。
3.2.2.3	allowedAgentRestMaxNum	number	所有队列最大允许休息人数。取值范围1~1000。默认值为1000。
3.2.2.4	callDispatchBySkillModel	number	呼叫分配方式。 0：技能最佳分配 1：平均分配 2：技能多者优先分配默认值为0。
3.2.2.5	dialupRouteStrategy	number	收号信息路由策略。 0：使用呼入被叫 + 收号信息路由 1：使用匹配呼叫 + 收号信息路由默认值为0。
3.2.2.6	flowFilePath	string	流程文件存放路径。最大长度为255字节。
3.2.2.7	forceVdnSelfRecord	number	VDN强制自录制。 0：禁用 1：对所有话务员启用 2：由质检员选择话务员启用 3：按百分比录制默认值为1。
3.2.2.8	selfRecordMediaType	number	录制的媒体类型。 0：只录音频 1：录制音频和视频默认值为0。
3.2.2.9	recordVideoFormat	number	录制的视频文件格式。 0：视频缺省文件格式，在录音资源侧配置 1：AVI格式 2：3GP格式默认值为0。
3.2.2.10	ifCancelBusyWhenCallOut	number	0：退出示忙 1：保持示忙默认值为0。
3.2.2.11	queueCancelKey	string	取消排队键。最大长度为1字节。可取值为0123456789#。默认值？。
3.2.2.12	recordFormateOki	number	CP台会场录音格式。 0：缺省格式，可在CP台配置 2：24K VOX 8：32K VOX 16：64K Alaw 默认值为0。
3.2.2.13	systemAni	number	系统主叫号码。可取值为0123456789*#。最大长度24字节。
3.2.2.14	vpLang	number	VP音报工号语种。 0：普通话 1：英语 2：方言1 3：方言2 默认值为0。
3.2.2.15	singlePhoneDisplayedNo	number	单电话座席来电显示。 0：系统主叫 1：客户号码默认值为0。
3.2.2.16	pcPhoneDisplayNo	number	PC+PHONE座席电话来电显示。 0：系统主叫。 1：客户号码。默认值为0。
3.2.2.17	ifBusyNoAnswerAgent	number	座席久不应答座席是否示忙。 0：否。 1：是。默认值为1。
3.2.2.18	timeZone	string	vdn所在的时区。当为空白字符串时，表示使用配置提交时的系统默认时区。
3.2.2.19	dstEnable	number	是否启用夏令时，默认值为0。南半球夏令时结束时间可能小于开始时间，需调用方保证夏令时结束时间正确性。 0：不启用，1启用
3.2.2.20	dstOffsetTime	number	夏令时偏移时间（单位：分钟），取值范围为[-1440,1440]，默认值为0。
3.2.2.21	dstStartMonth	number	夏令时开始月份，默认值为3。
3.2.2.22	dstStartIndex	number	夏令时开始周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。
3.2.2.23	dstStartWeekDay	number	夏令时开始星期，默认值为1。1：星期天，2：星期1,...7：星期6。
3.2.2.24	dstStartTime	string	夏令时开始时间点，此时间为本地非夏令时时间，默认值为 "00:00"。
3.2.2.25	dstEndMonth	number	夏令时结束月份，默认值为10。
3.2.2.26	dstEndIndex	number	夏令时结束周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。
3.2.2.27	dstEndWeekDay	number	夏令时结束星期，默认值为1。1：星期天，2：星期1,...7：星期6。
3.2.2.28	dstEndTime	string	夏令时结束时间点，此时间为本地非夏令时时间，默认值为 "00:00"。
3.2.2.29	multiMediaSynFlag	number	租户支持业务代表同时处理多种媒体呼叫。取值范围： 1：开启 0：不开启缺省值：0
3.2.2.30	recordRuleId	string	H5视频录制规则Id 说明：参数已废弃。
3.2.2.31	recordPath	string	H5视频录制文件存储路径说明：参数已废弃。
3.2.2.32	screenshotRuleId	string	H5视频截图规则Id 说明：参数已废弃。
3.2.2.33	screenshotPath	string	H5视频截图文件存储路径说明：参数已废弃。
3.2.2.34	virtualCallInDetectFlag	int	外呼是否启动ACD检测，取值范围： 0：不启动检测 1：接通前启动检测 2：接通后启动检测
3.2.2.35	virtualCallInDetectType	int	外呼检测开启方式，取值范围： 0：按VDN开启 1：按OBS任务开启
3.2.2.36	waitDetectResTime	int	外呼等待检测结果时长(s)，取值范围：1~20
3.2.2.37	detectResProMode	int	外呼收到非人工应答检测结果处理方式，取值范围： 0：释放 1：接通
3.2.2.38	detectTimeOutProMode	int	外呼等待检测结果超时处理方式，取值范围： 0：释放 1：接通
3.2.2.39	supportEncryptRecord	int	是否开启录音文件加密，取值范围： 1：是 0：否
3.2.2.40	agentRecordKeyScene	string	进行录音文件加密时，kms密钥的scene
3.2.2.41	agentRecordKeyAlias	string	进行录音文件加密时，kms密钥的alias
3.2.2.42	ivrRecordKeyScene	string	进行IVR录音文件加密时，kms密钥的scene
3.2.2.43	ivrRecordKeyAlias	string	进行IVR录音文件加密时，kms密钥的alias
3.2.2.44	supportScreenRecordEncrypt	int	是否开启录屏文件加密，取值范围： 1：是 0：否
3.2.2.45	screenRecordKeyScene	string	进行录屏文件加密时，kms密钥的scene
3.2.2.46	screenRecordKeyAlias	string	进行录屏文件加密时，kms密钥的alias

报文样例

消息头

Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

请求参数
 无

响应参数

{
    "message": "success",
    "retcode": "0",
    "result": [
        {
            "data": {
                "vdnInfo": {
                    "singlePhoneDisplayedNo": 0,
                    "dstEndMonth": 10,
                    "queueCancelKey": "*",
                    "dstStartIndex": 1,
                    "pcPhoneDisplayNo": 0,
                    "recordRuleId": "",
                    "dstEnable": 0,
                    "accessCodes": [
                        "1909799866",
                        "99998888"
                    ],
                    "dstStartMonth": 3,
                    "forceVdnSelfRecord": 1,
                    "dstEndWeekDay": 1,
                    "forceVideoSelfRecord": 0,
                    "dstEndIndex": 1,
                    "screenshotPath": "",
                    "allowDrvPlayQueueVoice": 0,
                    "recordVideoFormat": 0,
                    "recordPath": "",
                    "dialupRouteStrategy": 0,
                    "ifCancelBusyWhenCallOut": 0,
                    "systemAni": "1909799866",
                    "dstEndTime": "00:00",
                    "recordFormateOki": 0,
                    "vpLang": 0,
                    "flowFilePath": ".\\flow",
                    "allowedAgentRestMaxNum": 1000,
                    "dstStartTime": "00:00",
                    "selfRecordMediaType": 0,
                    "timeZone": "",
                    "ifBusyNoAnswerAgent": 1,
                    "callDispatchBySkillModel": 0,
                    "dstOffsetTime": 0,
                    "dstStartWeekDay": 1,
                    "multiMediaSynFlag": 1,
                    "screenshotRuleId": ""
                },
                "vdnSetup": {
                    "ccdisId": 1,
                    "isAllowedChangePassword": 1,
                    "mediaAgentChn": [
                        {
                            "chnType": 50,
                            "agentNum": 0,
                            "mmCallNum": 1
                        },
                        {
                            "chnType": 51,
                            "agentNum": 0,
                            "mmCallNum": 1
                        },
                        {
                            "chnType": 52,
                            "agentNum": 0,
                            "mmCallNum": 1
                        },
                        {
                            "chnType": 53,
                            "agentNum": 0,
                            "mmCallNum": 1
                        },
                        {
                            "chnType": 54,
                            "agentNum": 0,
                            "mmCallNum": 1
                        },
                        {
                            "chnType": 55,
                            "agentNum": 0,
                            "mmCallNum": 1
                        }
                    ],
                    "obsDbSource2Id": 0,
                    "accessCodes": [
                        "1909799866",
                        "99998888"
                    ],
                    "obsProcName": "spHuaweiGetOutBoundPVersion",
                    "rcdSys": 1,
                    "minPasswordAvailableTime": 5,
                    "vdnLimitedCalloutNoPrefixList": [
                        "1909799866",
                        "99998888"
                    ],
                    "modifyPasswordAfterInit": 0,
                    "allowedObsCallNum": 1000,
                    "allowedWebCallNum": 0,
                    "isAllowedWebCall": 1,
                    "allowedIVRCallNum": 0,
                    "allowedUapConfVideoCallNum": 0,
                    "supportDouble": 1,
                    "vdnName": "workDayCreate",
                    "isLimitCalloutNoPrefix": 1,
                    "recordFileDisks": [
                        "Y"
                    ],
                    "allowedVideoAgentNum": 0,
                    "allowedCloudVcChannelNum": 4996,
                    "allowedIVRVideoCallNum": 0,
                    "obsDbSourceId": 0,
                    "resGroupId": 1,
                    "allowedTTSAndASRCallNum": 1,
                    "unLockTime": 10,
                    "obsId": 0,
                    "ivrIds": [
                        3
                    ],
                    "allowedPstnCallNum": 30,
                    "obsInterfaceType": 0,
                    "safeLevel": 1,
                    "administratorWorkNo": 56088,
                    "workNoScopes": [
                        {
                            "workNoStart": 4199,
                            "workNoEnd": 4199
                        },
                        {
                            "workNoStart": 56087,
                            "workNoEnd": 56088
                        }
                    ],
                    "minPasswordLength": 8,
                    "vdnVideoMode": 2,
                    "allowedAgentNum": 1,
                    "prePromptTime": 15,
                    "mediaChanTotalCallNum": 10,
                    "vdnEnabled": 1,
                    "allowedWebCallNum": 1
                }
            },
            "vdnId": 477
        }
    ]
}

查询

场景描述

接口方法

接口URI

日志中的方法名

请求消息

响应消息

报文样例

相关文档

意见反馈

文档内容是否对您有帮助？