文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 监控/统计/ 系统指标查询接口/ 查询控制块关键信息
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询控制块关键信息

调用该接口的并发数量不要超过10，否则存在并发性能问题，导致调用接口超时。

前置条件

该接口仅支持全局AK/SK鉴权调用。

注意：本接口仅支持独立部署环境。

场景描述

用于请求系统显示指定控制块的运行状态。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELTE等方法。

请求URL

https://ip:port/rest/cmsapp/v1/openapi/uap/dsppidkey

其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
表2 请求消息体参数说明

参数名

数据类型

是否必选

说明

MODTYP

String

True

用于指定模块类型。

当前支持：CCU和MSU

PID

String

条件必填

CCU模块ID

仅当 “模块类型”设置为 “CCU”时，该参数有效。用于指定CCU模块号。

PIDMSU

String

条件必填

MSU模块ID

仅当“模块类型”设置为“MSU”时，该参数有效。用于指定MSU模块的模块号。

MN

String

条件必填

CCU模块号

仅当“模块类型”设置为“CCU”且配置了“CCU模块ID”时，该参数有效。用于指定CCU模块号，操作员可以使用LST APP命令查询获得。

BICCTYPE

String

条件必填

BICC类型

仅当“模块类型”设置为“CCU”并且“CCU模块ID”设置为“BICC”时，该参数有效，用于指定BICC类型。

MSUMN

String

条件必填

MSU模块号

仅当“模块类型”设置为“MSU”且配置了“MSU模块ID”时，该参数有效。用于指定MSU模块号，操作员可以使用LST APP命令查询获得。

ccId

int

False

呼叫中心编号

  • 独立部署环境，默认值为系统管理员登录AICC系统后，通过“配置中心 > 系统管理 > 参数配置”查看“默认呼叫中心标识”的值。

响应消息

表3 响应消息体参数说明

参数名

数据类型

说明

resultCode

String

查询结果。取值如下：

  • "0100000"：成功
  • 其他：失败
  • 失败的原因说明请参见错误码参考。

resultDesc

List

查询成功后，返回结果信息的对象列表。

该数组中对象的参数说明请参见下表。

10.xx.xx.xx#0

String
  • 10.xx.xx.xx：UAP IP
  • “#”：固定分隔符
  • “0”：UAP编号
表4 resultDesc对象参数说明（设置“模块类型”为“CCU”，“CCU模块ID”为“CCB”，“CCU模块号”为“57”）

参数名

数据类型

说明

IDC switch index

String

在线指示

Null CB number

String

处于NULL状态的控制块个数

Booked CB number

String

忙电路数

Info receiving status number

String

处于信息接收的控制块个数

Wait overlap CB number

String

处于WAITOVERLAP状态的个数

Overlap transmit number

String

处于Overlap transmit的个数

Call proceeding number

String

处于CALLPROCEEDIN的个数

Alerting CB number

String

处于ALERTING状态的个数

Connection request CB number

String

处于连接请求的个数

Active CB number

String

处于激活状态的个数

Release guard CB number

String

处于Release guard的个数

Release waiting CB number

String

处于释放等待的个数

Temply hold CB number

String

处于Temply hold状态的个数

Wait tone CB number

String

处于等待tone音的个数

Null after combine CB number

String

处于NULLAFTERCOMBINE的个数

Call park CB number

String

处于Call park的控制块个数
表5 resultDesc对象参数说明（设置“模块类型”为“CCU”，“CCU模块ID”为“INTESS”，“CCU模块号”为“56”）

参数名

数据类型

说明

Last allocated INTESS number

String

上次分配的INTESS控制块号

Error stat flag

String

错误原因统计开关

Error stat interval

String

错误原因统计周期

Message statistics flag

String

消息统计开关

Message statistics interval

String

消息统计周期

Message statistics mask

String

消息统计掩码

Idle CB number

String

处于IDLE状态的控制块个数

Overlap CB number

String

处于OVERLAP状态的控制块个数

Call delivered CB number

String

处于CALLDELIVERED状态的控制块个数

Call present CB number

String

处于CALLPRESENT状态的控制块个数

Call received

String

处于CALLRECEIVED状态的控制块个数

Connection request CB number

String

处于连接请求状态的控制块个数

Active CB number

String

处于ACTIVE状态的控制块个数

SPACTIVE CB number

String

处于SPACTIVE状态的控制块个数

CB number in INTESS_spy state

String

处于INTESS_SPY状态的控制块个数

Wait REL CB number

String

处于WAITREL状态的控制块个数
表6 resultDesc对象参数说明（设置“模块类型”为“MSU”，“PIDMSU模块ID”为“BSI”，“MSUMN模块号”为“472”）

参数名

数据类型

说明

Total number of connections

String

连接总数

Total no of connection in IDLE state

String

空闲状态连接总数

Total no of connection in CREATE CONNECT state

String

正在创建状态的连接总数

Total no of connection in CONNECT state

String

已经连接状态连接总数

Total no of connection in DELETE CONNECT state

String

删除状态连接总数

Total no of connection in MODIFY CONNECT state

String

修改状态连接总数

Total no of connection having service type as IVR

String

IVR业务连接总数

Total no of connection having service type as CONF

String

会场业务连接总数

Total no of connection having service type as CONF CHAN

String

会场通道业务连接总数

Total no of conf connection in IDLE state

String

空闲状态会场连接总数

Total number of Conf connections

String

会场连接总数

Total no of conf connection in CREATE CONF state

String

正在创建状态会场连接总数

Total no of conf connection in CONF USING state

String

使用状态会场连接总数

Total no of conf connection in CONF DELETE state

String

删除状态会场连接总数

样例报文

  • 请求头： 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • 请求参数： 
    {
   "MODTYP":"CCU",
   "PID":"CCB",
   "MN":"56",
   "ccId":1
}
  • 响应参数： 
    {
    "resultCode": "0100000",
    "resultDesc": {
    "10.xx.xx.xx#0": {
        "Alerting CB number": "0",
        "Null after combine CB number": "0",
        "IDC switch index": "1",
        "Wait tone CB number": "0",
        "Release guard CB number": "0",
        "Release waiting CB number": "0",
        "Booked CB number": "0",
        "Temply hold CB number": "0",
        "Active CB number": "0",
        "Info receiving status number": "3",
        "Call park CB number": "0",
        "Null CB number": "9997",
        "Overlap transmit number": "0",
        "Call proceeding number": "0",
        "Wait overlap CB number": "0",
        "Connection request CB number": "0"
        }
    }
}

相关文档