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

Obtaining the Co-browsing URL

Function

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

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/cobrowseSiteInfo/getCobrowseSiteById

{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

siteId

Yes

String

Co-browsing ID.

Response Parameters

Parameter

Mandatory or Not

Type

Description

returnCode

Yes

String

Interface response code. The value 0 indicates success.

description

Yes

String

Interface description.

data

No

Object

Co-browsing connection information.
Table 3 data parameters

Parameter

Mandatory or Not

Type

Description

id

No

String

Multimedia data ID (maximum length: 64 bytes).

parentTypeId

No

String

Multimedia library category ID (maximum length: 64 bytes).

mediaUrl

No

String

Multimedia URL (maximum length: 1024 bytes).

mediaType

No

String

Multimedia data type (fixed value: COBROWSESITE).

duration

No

String

Duration of a voice or video file (maximum length: 20 bytes).

name

No

String

Multimedia data name (maximum length: 200 bytes).

description

No

String

Multimedia data description (maximum length: 1000 bytes).

latitude

No

String

Latitude of an address (maximum length: 20 bytes).

longitude

No

String

Longitude of an address (maximum length: 20 bytes).

fileName

No

String

File name (maximum length: 100 bytes).

fileSize

No

String

File size (maximum length: 4 bytes).

sizeUnit

No

String

File size unit. The options are KB and MB.

mediaFileType

No

String

Media file type. The fixed value NULL is returned for this interface.

Example

  • Request 
    POST /service-cloud/rest/webadapter/v1/cobrowseSiteInfo/getCobrowseSiteById

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

{
    "siteId":"xx"
}
  • Response 
    {
    "returnCode": "0",
    "data": {
        "fileName": null,
        "parentTypeId": "1613009459437342721",
        "mediaUrl": "https://***",
        "latitude": null,
        "description": "",
        "mediaType": "COBROWSESITE",
        "duration": null,
        "fileSize": null,
        "name": "Co-browsing URL",
        "sizeUnit": null,
        "id": "1699621860646301698",
        "mediaFileType": null,
        "longitude": null
    },
    "description": "success"
}
Parent topic: Web Channel