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

查询

场景描述

调用该接口查询VDN组。

接口方法

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

接口URI

https://ip:port/agentgateway/resource/config/sys/vdngroup?ids=5,4&parentId=xx

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

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

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

ids

string

False
  • 需要查询的VDN组编号列表。
  • 为空时，表示查询所有VDN组的数据。
  • 查询多个VDN组时，以“,”逗号分隔。

2

parentId

number

False

父vdn组的编号。

日志中的方法名

queryVdnGroup

请求消息

  • 消息头
    表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

操作的结果原因码。

取值类型为整数。

3

result

array

返回结果。该数组中的对象参数说明请参见表4。
表4 result数组对象参数

序号

名称

参数类型

说明

1.1

parentId

number

用于标识父VDN组Id，默认值null表示是顶级VDN组，不挂在其它VDN组中。

1.2

groupName

number

VDN管理员。

1.3

adminName

string

VDN组管理员姓名。

最大长度25, 不允许配置的特殊字符："[]'&()=;<>,

1.4

adminWorkNo

number

VDN组管理员工号。

取值范围为60000~65000，非空

1.5

adminPassword

number

VDN组管理员密码。

密码规则：最大长度32，不能有中文字符

1.6

allowedAgentNum

number

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

取值范围为0-20000。

默认值为0。

1.7

allowedVideoAgentNum

number

允许的最大视频座席数。

取值范围为0-20000。

默认值为0。

1.8

allowedPstnCallNum

number

并发PSTN最大呼叫数。

取值范围为1-60000。

默认值为1。

1.9

allowedWebCallNum

number

并发Web最大呼叫数。

取值范围为0-20000。

默认值为0。

1.10

allowedOutBoundCallNum

number

最大并发OutBound呼出数。

取值范围为0-65535。

默认值为1000。

1.11

allowedCpConfPartyNum

array

会场方数。

取值范围为0-65535。

默认值为65535。

1.12

allowedIVRCallNum

number

并发IVR最大呼叫数。

取值范围为0-100000。

默认值为0。

1.13

allowedCloudVcChannelNum

number

并发CloudVC视频通道数。

取值范围为0-50000。

默认值为0。

1.14

allowedUapConfVideoCallNum

number

UAP视频会场方数。

取值范围为0-50000。

默认值为0。

1.15

allowedTTSAndASRCallNum

number

智能IVR通道数。

取值范围为0~65535。

默认值为0。

1.16

allowedASRAgentNum

number

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

取值范围为0-20000。

默认值为0。

1.17

allowedIVRVideoCallNum

number

并发视频IVR最大呼叫数

取值范围为0-100000。

默认值为0。

1.18

workNoScopes

array

工号范围。

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

1.19

accessCodeIds

array

接入码Id

1.20

dbSourceIds

array

数据源

1.21

ivrIds

array

IVR。

1.22

dirId

array

自录音盘符。盘符id。

1.23

mediaAgentChn

array

多媒体渠道配置，字段说明如mediaAgentChn多媒体渠道配置所示

1.24

vdnIds

array

本VDN组包含的VDN编号

1.25

recordFileDisks

array

自录音盘符，盘符名称。
表5 workNoScopes对象数组参数说明

序号

名称

参数类型

说明

3.2.1.22.1

workNoStart

number

起始工号。

3.2.1.22.2

workNoEnd

number

结束工号。
表6 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，目前暂不支持查询出结果。

报文样例

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

    无

  • 响应参数 
    {
    "message": "success",
    "retcode": "0",
    "result": [
        { 
            "parentId": 0,
            "groupName": "testVdnGroup",
            "adminName": "testVdnGroup",
            "adminWorkNo": "60001",
            "adminPassword": "********",
            "allowedAgentNum": 2,
            "allowedVideoAgentNum": 2,
            "allowedPstnCallNum": 2,
            "allowedWebCallNum": 2,
            "allowedOutBoundCallNum": 2,
            "allowedCpConfPartyNum": 2,
            "allowedIVRCallNum": 2,
            "allowedCloudVcChannelNum": 2,
            "allowedUapConfVideoCallNum": 2,
            "allowedTTSAndASRCallNum": 2,
            "allowedASRAgentNum": 2,
            "allowedIVRVideoCallNum": 2,
            "workNoScopes": [
               {
                   "workNoStart": 869,
                   "workNoEnd": 869
                }
            ],
            "accessCodeIds": [
                 1, 2
            ],
            "dbSourceIds":[],
            "ivrIds":[],
            "dirId":[],
            "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
                }
            ],
            "vdnIds":[1, 2]
        }
    ]
}
父主题： VDN组

相关文档