文档首页/ 云客服/ API参考/ CC-Gateway 配置接口参考/ VDN配置接口说明/ VDN/ 查询
更新时间：2025-12-01 GMT+08:00
查看PDF
分享

查询

场景描述

调用该接口查询VDN。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/vdn/vdn

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

日志中的方法名

queryVdnInfo

请求消息

  • 消息头
    表1 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

响应消息

表2 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

object

查询结果，该对象的参数说明请参见表 查询结果对象消息体参数说明。
表3 查询结果对象消息体参数说明

序号

名称

参数类型

说明

3.1

vdnSetup

object

VDN设置。

该对象的参数说明请参见表 vdnSetup对象参数说明。

3.2

vdnInfo

object

VDN基本信息。

该对象的参数说明请参见表 vdnInfo对象参数说明。
表4 vdnSetup对象参数说明

序号

名称

参数类型

说明

3.1.1

accessCodes

array

系统接入码。

3.1.2

administratorWorkNo

number

VDN管理员。

3.1.3

allowedAgentNum

number

同时签入的最大业务代表数。

取值范围为1～20000。

默认值为4。

3.1.4

allowedVideoAgentNum

number

同时签入的最大视频业务代表数。

取值范围为0～20000。

默认值为0。

3.1.5

allowedObsCallNum

number

最大并发OutBound呼出数。

取值范围为0～65535。

3.1.6

allowedPstnCallNum

number

并发语音最大呼叫数。

取值范围为1～60000。

默认值为10。

3.1.7

allowedWebCallNum

number

并发Web最大呼叫数。

取值范围为1～20000。

3.1.8

allowedIVRVideoCallNum

number

最大并发IVR视频呼叫数

取值范围0-100000。

默认值4。

3.1.9

allowedCloudVcChannelNum

number

并发CloudVC视频通道数

取值范围0-50000。

默认值4。

3.1.10

ivrIds

array

IVR ID数组。

3.1.11

vdnEnabled

number

启用禁用VDN。

  • 0：禁止使用
  • 1：允许使用

默认值为1。

3.1.12

vdnName

string

VDN名称。

最大长度为20字节。

3.1.13

workNoScopes

array

工号范围。

请参见表 workNoScopes对象数组参数说明。

3.1.14

isLimitCalloutNoPrefix

number

限制VDN主叫号码。

  • 0：否
  • 1：是

默认值为0。

3.1.15

vdnLimitedCalloutNoPrefixList

array

可用的主叫号码前缀。

取值类型为数组。

主叫号码前缀数组最大长度100。

单个主叫号码前缀长度为24。

单个主叫号码前缀取值为0123456789*#。

3.1.16

recordFileDisks

array

自录音盘符。

3.1.17

vdnVideoMode

number

视频应用模式。

  • 0：SFU(UAP)
  • 1：MCU(CloudVC）
  • 2：MCU(CloudVC)+SFU
  • 3：MCU(UAP)

默认值为0。

3.1.18

allowedUapConfVideoCallNum

number

UAP视频会场方数。

  • 当vdnVideoMode为3时该参数才生效。租间的allowedUapConfVideoCallNum最大不超过CTI license申请的UAP视频会场方数，且租间可配置范围：allowedUapConfVideoCallNum = CTI license申请的UAP视频会场方数 - 其余租间allowedUapConfVideoCallNum之和。
  • 当vdnVideoMode不为3时，allowedUapConfVideoCallNum为0。

3.1.19

allowedIVRCallNum

number

并发IVR最大呼叫数

取值范围为0-100000

默认值为0。

3.1.20

mediaChanTotalCallNum

number

VDN级座席多媒体全渠道总并发数

取值范围：[0,60]

0表示不限制全渠道总并发数

3.1.21

mmConcurrentCallNum

array

座席并发处理多媒体呼叫数,字段说明如表8所示。
表5 workNoScopes对象数组参数说明

序号

名称

参数类型

说明

3.1.13.1

workNoStart

number

起始工号。

3.1.13.2

workNoEnd

number

结束工号。
表6 vdnInfo对象参数说明

序号

名称

参数类型

说明

3.2.1

accessCodes

array

系统接入码。

3.2.2

allowedAgentRestMaxNum

number

所有队列最大允许休息人数。

取值范围1~1000。

默认值为1000。

3.2.3

systemAni

string

系统主叫号码。

可取值为0123456789*#。最大长度24字节。

3.2.4

callDispatchBySkillModel

number

呼叫分配方式。

  • 0：技能最佳分配
  • 1：平均分配
  • 2：技能多者优先分配
  • 3：来话比呼出技能优先分配

默认值为0。

3.2.5

forceVdnSelfRecord

number

VDN强制自录制。

  • 0：禁用
  • 1：对所有话务员启用
  • 2：由质检员选择话务员启用
  • 3：按百分比录制

默认值为1。

3.2.6

queueCancelKey

string

取消排队键。

最大长度为1字节。

可取值为0123456789*#。

3.2.7

recordFormateOki

number

CP台会场录音格式。

  • 0：缺省格式，可在CP台配置
  • 2：24K VOX
  • 8：32K VOX
  • 16：64K Alaw

默认值为0。

3.2.8

ccSRoutePolicy

number

CCS路由策略。

  • 0：无条件按客户级别路由
  • 1：参考客户排队时长路由
  • 2：有条件按客户级别路由

默认值为0。

3.2.9

callOutRecord

number

呼出呼叫录音发起时机。

  • 0：振铃后
  • 1：通话后

默认值为0。

3.2.10

callInRecord

number

呼入呼叫录音发起时机。

  • 0：振铃后
  • 1：通话后

默认值为0。

3.2.11

singlePhoneDisplayedNo

number

单电话座席来电显示。

  • 0：系统主叫
  • 1：客户号码

默认值为0。

3.2.12

pcPhoneDisplayNo

number

PC+PHONE座席电话来电显示。

  • 0：系统主叫
  • 1：客户号码

默认值为0。

3.2.13

isUseVdnAlertingVoice

number

是否使用VDN配置的回铃音

  • 0：使用系统配置的回铃音
  • 1：使用VDN配置的回铃音

默认值为0

3.2.14

alertingVoice

object

回铃音信息

该对象的参数说明请参见表7。

3.2.15

videoRecordingMode

number

视频录制模式

  • 0：三方画面等大
  • 1：客户画面最大
  • 2：坐席画面最大
  • 3：第三方画面最大

默认值为0。

3.2.16

restQueueRule

number

休息排队策略。

  • 0：先申请者优先休息
  • 1：当天休息时间比例少者优先休息

3.2.17

ifReleaseNoAnswerCall

number

座席久不应答呼叫是否释放。

  • 0：否
  • 1：是

3.2.18

ifBusyNoAnswerAgent

number

座席久不应答座席是否示忙。

  • 0：否
  • 1：是

3.2.19

multiMediaSynFlag

number

允许业务代表同时处理多种媒体呼叫。

  • 0：否
  • 1：是

3.2.20

timeZone

string

vdn所在的时区。当为空白字符串时，表示使用配置提交时的系统默认时区。

3.2.21

dstEnable

number

是否启用夏令时，默认值为0。南半球夏令时结束时间可能小于开始时间，需调用方保证夏令时结束时间正确性。

0：不启用，1启用

3.2.22

dstOffsetTime

number

夏令时偏移时间（单位：分钟），取值范围 为[-1440,1440]，默认值为0。

3.2.23

dstStartMonth

number

夏令时开始月份，默认值为3。

3.2.24

dstStartIndex

number

夏令时开始周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。

3.2.25

dstStartWeekDay

number

夏令时开始星期，默认值为1。1：星期天，2：星期1,...7：星期6

3.2.26

dstStartTime

string

夏令时开始时间点，此时间为本地非夏令时时间，默认值为 "00:00"。

3.2.27

dstEndMonth

number

夏令时结束月份，默认值为10。

3.2.28

dstEndIndex

number

夏令时结束周次，默认值为1。1~4：第1周~第4周；-1~-4：倒数第1周~倒数第4周。

3.2.29

dstEndWeekDay

number

夏令时结束星期，默认值为1。1：星期天，2：星期1,...7：星期6

3.2.30

dstEndTime

string

夏令时结束时间点，此时间为本地非夏令时时间，默认值为 "00:00"。

3.2.31

recordRuleId

string

H5视频录制规则Id

说明：

参数已废弃。

3.2.32

recordPath

string

H5视频录制文件存储路径

说明：

参数已废弃。

3.2.33

screenshotRuleId

string

H5视频截图规则Id

说明：

参数已废弃。

3.2.34

screenshotPath

string

H5视频截图文件存储路径

说明：

参数已废弃。
表7 alertingVoice对象参数说明

序号

名称

参数类型

说明

3.2.14.1

parameterType

string

参数类型。

默认为Voice 语音类型

3.2.14.2

voiceType

number

语音类型

  • 1：SPT放音
  • 2：VP放音
  • 3：SIG放音
  • 4：不播放语音

默认为3

3.2.14.3

voiceChildType

number

语音子类型

当voiceType为1时：

  • 1：普通话
  • 2：英语
  • 3：方言1
  • 4：方言2

当voiceType为2时：

  • 5：放提示音
  • 6：放指定文件

当voiceType为3或4时：

  • 7：没有配置

默认为7

3.2.14.4

voiceValue

string

文件/序号

当voiceType为1时：为SPT语音编码

当voiceType为2时：

  • voiceChildType为5时，提示音序号。如：66。
  • voiceChileType为6时，VP文件名称。如：“ENT66.in”。

当voiceType为3时：为语音句柄参数

当voiceType为4时：为空

默认为6
表8 mmConcurrentCallNum多媒体渠道配置

序号

名称

参数类型

说明

3.1.21.1

chnType

number

媒体类型。其中：

50：多媒体Email

51：多媒体Web Chat

52：多媒体SMS

53：Social Chat

56：多媒体Wechat

57：多媒体Facebook

58：多媒体Twitter

59：多媒体5G

60：多媒体Line

61：多媒体WhatsApp

62：多媒体Instagram

63：多媒体Telegram

3.1.21.2

mmCallNum

number

座席最大多媒体会话数，[0,60]

0表示没有并发

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

    无

  • 响应参数 
    {
    "result": [
        {
            "vdnInfo": {
                "singlePhoneDisplayedNo": 0,
                "systemAni": "10086",
                "ccSRoutePolicy": 0,
                "recordFormateOki": 0,
                "queueCancelKey": "*",
                "videoRecordingMode": 0,
                "allowedAgentRestMaxNum": 1,
                "pcPhoneDisplayNo": 0,
                "callInRecord": 0,
                "accessCodes": [
                    "10086"
                ],
                "alertingVoice": {
                    "parameterType": "Voice",
                    "voiceValue": "",
                    "voiceChildType": 7,
                    "voiceType": 4
                },
                "isUseVdnAlertingVoice": 1,
                "callOutRecord": 0,
                "forceVdnSelfRecord": 1,
                "callDispatchBySkillModel": 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"
            },
            "vdnSetup": {
                "isLimitCalloutNoPrefix": 0,
                "recordFileDisks": [],
                "allowedVideoAgentNum": 0,
                "allowedCloudVcChannelNum": 24,
                "allowedIVRVideoCallNum": 10,
                "allowedUapConfVideoCallNum": 0,
                "vdnVideoMode": 2,
                "accessCodes": [
                    "10086",
                    "10087"
                ],
                "allowedPstnCallNum": 10,
                "ivrIds": [
                    2,
                    3
                ],
                "vdnLimitedCalloutNoPrefixList": [],
                "administratorWorkNo": 101,
                "allowedObsCallNum": 0,
                "workNoScopes": [
                    {
                        "workNoStart": 101,
                        "workNoEnd": 15000
                    }
                ],
                "allowedWebCallNum": 0,
                "allowedAgentNum": 10,
                "vdnName": "10086",
                "vdnEnabled": 1,
                "mediaChanTotalCallnum": 12,
                "mmConcurrentCallNum": [
                    {
                        "chnType": 50,
                        "mmCallNum": 5
                    }
                ],
                "allowedIVRCallNum": 0
            }
        }
    ],
    "message": "success",
    "retcode": "0"
}
父主题： VDN

相关文档