On this page

Show all

Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Interfaces for Querying System Indicators/ Querying the Registration Status of a Terminal

Querying the Registration Status of a Terminal

Updated on 2023-12-19 GMT+08:00

View PDF

NOTICE:

The number of concurrent requests for invoking the interface cannot exceed 10. Otherwise, the interface invoking times out due to deteriorated performance.

Prerequisites

This interface is invoked only for global AK/SK authentication.

Note: This interface supports only the independent deployment environment.

Description

This interface is invoked to query the registration status of a terminal.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Request URL

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

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

**Table 1** Parameters in the request header
No.	Parameter	Type	Mandatory	Description
1	Content-Type	String	Yes	The value is fixed to application/json; charset=UTF-8.
2	Authorization	String	Yes	For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

**Table 2** Parameters in the request message body
Parameter	Type	Mandatory	Description
EID	string	Yes	It specifies the ID of the multimedia device to be operated. The rules for setting the parameter are as follows: For a multimedia device that adopts the SIP, the value is a string, which generally contains up to 32 digits, for example, 8780001. The asterisk () and percent (%) can match zero or multiple characters. For example, 6666 and 6666% match all character strings starting with 6666. The question mark (?) matches only one character. For example, 6666? matches only five-character strings starting with 6666. The combination of the asterisk (), question mark (?), and percent sign (%) is supported. For example, %3?* matches all character strings whose penultimate character is 3. NOTICE: The number of wildcard matching results must be less than 200. Otherwise, UAP services are affected.
limit	Integer	False and offset appear in pairs.	Query quantity. The default value is 100.
offset	Integer	False and limit appear in pairs.	Start position of the query. The default value is 0.
ccId	Integer	No	ID of a call center. In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

Response Message

**Table 3** Parameters in the response message body
Parameter	Type	Description
resultCode	string	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
resultDesc	List	Object list in the returned result after a successful query. For details about the parameters of the object, see the following table.
10.xx.xx.xx#1	String	10.xx.xx.xx: UAP IP address. #: fixed separator. 1: UAP ID.

**Table 4** Parameters of resultDesc
Parameter	Type	Description
data	list	Data result set.
count	Integer	Total number of records.

**Table 5** Parameters of data
Parameter	Type	Description
ccuModuleNumber	string	CCU module number.
terminationType	string	Terminal type.
equipmentId	string	Equipment ID.
registerStatus	string	Registration status. The value is registered or not register.
socketStatus	string	Socket status. The value is fault, normal, connecting, or uninstall.
ipAndPort	string	IP address and port number.
monitorFlag	string	Agent status monitoring flag. The value is unstarted or started.
protocolType	string	Protocol type.
roamIpAndPort	string	Roaming IP address and port number.
tlsStatus	string	TSL status. The value is unconnect, connect, or uninstall.
ipType	string	IP address type.

Message Example

Request header

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

Request parameters

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

Response parameters

{
    "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
    }
}

Parent topic: Interfaces for Querying System Indicators

Previous topic: Querying Key Information About Control Blocks

Next topic: Interface for Querying UAP Performance Indicator Statistics

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot