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 Time of the CTI Platform Server
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Querying the Time of the CTI Platform Server

Scenario

This interface is invoked to query the time of the CTI platform server. (CTI 3.6 does not support this interface.)

Interface Method

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

Internal Encapsulation Interface

BMS interface: /ccbms/ws/monitor/queryctiservertime

Request URL

https://ip:port/rest/cmsapp/v1/openapi/configures/ctiservertime

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

Value Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed at 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

No.

Parameter

Value Type

Mandatory

Description

1

ccId

Integer

Yes

ID of a call center.

The value ranges from 1 to 65535.

Response Description

Table 3 Parameters in the response message body

No.

Parameter

Value Type

Description

1

result

String

Query result. The options are as follows:

  • 0: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

2

resultCode

String

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

3

resultDatas

long

UTC timestamp of the server where the CTI platform is located.

NOTE:

This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.

4

resultDesc

Long

UTC timestamp of the server where the CTI platform is located.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1
}
  • Response parameters 
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": 1605057110000,
    "resultDesc": 1605057110000
}