Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Real-Time Data Query/ Real-Time Interfaces for VDNs/ Querying All Rest Reason Codes in a Specific VDN
Updated on 2023-12-19 GMT+08:00
View PDF

Querying All Rest Reason Codes in a Specific VDN

Scenario

This interface is invoked to query all rest reason codes in a specific VDN.

For details about how to configure the rest reason code, see "Configuring Rest Reason Codes" in (For Engineer) ICD VxxxRxxxCxx Product Documentation 01 (ICD).

Interface Method

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

Internal Encapsulation Interface

BMS interface: /ccbms/ws/monitor/restreason

Request URL

https://ip:port/rest/cmsapp/v1/openapi/agentgroup/restreasons/{ccId}/{vdn}

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.

No request body exists.

Table 2 Path parameters

No.

Parameter

Value Type

Mandatory

Description

1

ccId

Integer

Yes

ID of a call center.

The value ranges from 1 to 65535.

2

vdn

Integer

Yes

ID of a VDN.

The value ranges from 1 to 5000.

Response Description

Table 3 Parameters in the 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.12 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

Array

Object array in the returned result after a successful query.

For details about the parameters of the object in this array, see Table 4.

NOTE:

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

4

resultDesc

Array

Object array in the returned result after a successful query.

For details about the parameters of the object in this array, see Table 4.
Table 4 Parameters of resultDesc/resultDatas

No.

Parameter

Value Type

Description

2.1

restReasonId

Integer

Rest cause code.

2.2

restReason

String

Description of a rest cause.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters

    None

  • Response parameters
    {
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": [
        {
            "restReasonId": 100,
            "restReason": "Uncomfortable"
        }
    ],
    "resultDesc": [
        {
            "restReasonId": 100,
            "restReason": "Uncomfortable"
        }
    ]
}