本文导读

展开导读

文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 监控/统计/ 系统指标查询接口/ 查询终端注册状态

查询终端注册状态

更新时间：2023-12-19 GMT+08:00

查看PDF

须知：

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

前置条件

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

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

场景描述

查询终端注册状态信息。

接口方法

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

请求URL

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

其中，公有云环境请联系管理员获取，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 请求消息体参数说明
参数名	数据类型	是否必选	说明
EID	string	True	用于指定需要操作的多媒体设备的设备标识。该参数的配置原则是：对于采用SIP协议的多媒体设备，其格式为字符串（一般输入数字）、最大长度为32，例如8780001。和%匹配0个或多个字符。如6666和6666%，匹配所有以6666开头的字符串。？仅匹配1个任意字符。如6666？，仅匹配以6666开头、长度为5的字符串。支持通配符*、?、%的组合，如%3？，匹配所有倒数第二个字符为3的字符串。须知：请确保通配符匹配的结果小于200，否则会影响UAP侧正常业务。
limit	int	False 和offset成对出现	查询数量，不带该参数查询默认为100
offset	int	False 和limit成对出现	查询开始的位置，不带该参数查询默认为0
ccId	int	False	呼叫中心编号独立部署环境，默认值为系统管理员登录AICC系统后，通过“配置中心 > 系统管理 > 参数配置”查看“默认呼叫中心标识”的值。

响应消息

表3 响应消息体参数说明
参数名	数据类型	说明
resultCode	string	查询结果。取值如下： "0100000"：成功其他：失败失败的原因说明请参见错误码参考。
resultDesc	List	查询成功后，返回结果信息的对象列表。该数组中对象的参数说明请参见下表。
10.xx.xx.xx#1	String	10.xx.xx.xx：UAP IP “#”：固定分隔符 “1”：UAP编号

表4 resultDesc对象参数说明
参数名	数据类型	说明
data	list	数据结果集
count	int	总记录数

表5 data对象参数说明
参数名	数据类型	说明
ccuModuleNumber	string	CCU模块号
terminationType	string	终端类型
equipmentId	string	设备标识
registerStatus	string	注册状态：registered 已注册 not register 未注册
socketStatus	string	SOCKET状态： fault 故障 normal 正常 connecting 连接中 uninstall 未配置
ipAndPort	string	ip和Port
monitorFlag	string	座席状态监控标志： unstarted 未启动 started已启动
protocolType	string	协议类型
roamIpAndPort	string	漫游ip地址和端口
tlsStatus	string	TSL状态：unconnect 未连接 connect 连接 uninstall 未配置
ipType	string	ip类型

样例报文

请求头：

Content-Type: application/json;charset=UTF-8
Authorization: ******************

请求参数：

{
   "ccId":1,
   "EID": "8888*",
   "limit":"100",
   "offset":"0"
}

响应参数：

{
    "resultCode": "0100000",
    "resultDesc": {
        "data":
        {
           "10.xx.xx.xx#1": [
            {
                "socketStatus": "uninstall",
                "terminationType": "sip",
                "ipAndPort": "0.0.0.0:0",
                "ccuModuleNumber": "56",
                "registerStatus": "not register",
                "monitorFlag": "unstarted",
                "protocolType": "invalid protocol",
                "equipmentId": "88881757",
                "roamIpAndPort": "0.0.0.0:0",
                "tlsStatus": "uninstall",
                "ipType": "IPv4"
            }
           ],
           "10.xx.xx.xx#2": [
            {
                "socketStatus": "uninstall",
                "terminationType": "sip",
                "ipAndPort": "0.0.0.0:0",
                "ccuModuleNumber": "56",
                "registerStatus": "not register",
                "monitorFlag": "unstarted",
                "protocolType": "invalid protocol",
                "equipmentId": "88881757",
                "roamIpAndPort": "0.0.0.0:0",
                "tlsStatus": "uninstall",
                "ipType": "IPv4"
            }
           ]
        },
        "count": 1
    }
}

父主题： 系统指标查询接口

上一篇：查询控制块关键信息

下一篇：查询UAP性能指标统计接口

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

查询终端注册状态

前置条件

场景描述

接口方法

请求URL

请求说明

响应消息

样例报文

意见反馈

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

文档反馈