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

Querying Channel Configuration

Function

This interface is invoked to query channel configuration information on the web client page.

Usage Description

Prerequisites

The web channel configuration has been correctly created.

Interface Prototype

Table 1 Interface prototype description

Method

GET

URL

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

{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

queueReminderContent

Yes

String

Queuing notification content.

useRobot

Yes

String

Whether to use the chatbot.

toArtificialKeyWord

Yes

String

Keyword for switching from chatbot service to manual service.

queueReminderInterval

Yes

String

Queuing notification interval.

Example

  • Request 
    GET service-cloud/rest/webadapter/v1/webadapterfacade/queryChannelConfigByChannelAndId

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 
    {"queueReminderContent":null,"useRobot":"false","toArtificialKeyWord":null,"queueReminderInterval":10}
Parent topic: Web Channel