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

Obtaining the Co-browsing Feature

Function

This interface is invoked to obtain the co-browsing feature.

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/connectionInfo/queryTenantFeatureForCobrowse

{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

Parameter

Mandatory or Not

Type

Description

featureCode

Yes

String

Feature ID.

Response Parameters

Parameter

Mandatory or Not

Type

Description

retCode

Yes

String

Interface response code. The value 0 indicates success.

retMsg

No

String

Interface description.

data

No

Object

Feature information.
Table 3 data parameters

Parameter

Mandatory or Not

Type

Description

id

Yes

String

ID.

featureCode

Yes

String

Feature ID.

parentFTCode

Yes

String

Parent feature ID.

featureName

Yes

String

Feature name.

value

Yes

String

Feature value.

unit

No

String

Measurement unit description.

featureParams

No

String

Feature parameters.

tenantId

Yes

String

Tenant ID.

partdbId

Yes

String

Partition ID.

Example

  • Request 
    POST /service-cloud/rest/webadapter/v1/connectionInfo/queryTenantFeatureForCobrowse

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: */*

{
    "featureCode":"88001800100"
}
  • Response 
    {
    "retCode":"0",
    "data":{
        "id":"xx",
        "featureCode":"88001800100",
        "parentFTCode":"xx",
        "featureName":"xx",
        "value":"xx",
        "unit":"xx",
        "featureParams":"xx",
        "tenantId":"xx",
        "partdbId":"xx"
    }
}
Parent topic: Web Channel