Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ Web Channel/ Querying Queuing Information
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Queuing Information

Function

This interface is invoked to query the queuing information of the current session in the skill queue.

Usage Description

  • Prerequisites

    The web channel configuration has been correctly created.

Interface Prototype

Table 1 Interface prototype description

Method

POST

URL

https://{IP address}:{Port number}/service-cloud/rest/webadapter/v1/webadapterfacade/queryQueueInfo

{IP address}:{Port number} indicates the IP address and port number of the NSLB exposed externally.
Table 2 Request header parameters

Parameter

Mandatory or Not

Type

Default Value

Description

Content-Type

Yes

String

None

The value is fixed at application/json; charset=UTF-8.

Cookie

Yes

String

None

During page integration, the CC-Messaging writes the value of ccmessaging-token to browser cookies through the request response. When invoking this interface independently, ensure that the cookie in the request header contains ccmessaging-token=xxx, where xxx indicates the value of ccmessaging-token.

Request Parameters

None

Response Parameters

Parameter

Mandatory or Not

Type

Description

resultCode

Yes

String

Interface response code. The value 0 indicates success.

position

No

Array

Recommended common phrases.

totalWaitTime

No

Number

Accumulated queuing duration of the current call.

currentDeviceWaitTime

No

Number

Actual waiting duration in the current queue, in seconds.

configMaxcWaitTime

No

Number

Maximum waiting duration.

longestWaitTime

No

Number

Maximum queuing duration of a call that is queuing.

estimateWaitTime

No

Number

Estimated waiting duration in the current queue.

Example

  • Request 
    POST /service-cloud/rest/webadapter/v1/webadapterfacade/queryQueueInfo

host: 10.10.10.2:18446
connection: Keep-Alive
x-forwarded-for: 10.10.10.3, 10.10.10.4
x-real-ip: 10.10.10.5
content-length: 401
remote-host: 10.10.10.6
user-agent: java/socket
content-type: application/json; charset=utf-8
cookie: JSESSION*****#*#*****3
ccmessaging-token: ********
accept: */*
  • Response 
    {"resultCode":"xxx","position":1,"totalWaitTime":2,"currentDeviceWaitTime":3,"configMaxcWaitTime":4,"longestWaitTime":5,"estimateWaitTime":6}
Parent topic: Web Channel