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

Querying Web Card Information

Function

This interface is invoked to query web card information.

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/queryWebCardInfoById

{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

id

Yes

String

Web card ID.

Response Parameters

Table 3 Response parameters

Parameter

Mandatory or Not

Type

Description

id

Yes

String

Card ID.

title

Yes

String

Card title.

mediaType

Yes

String

Card type. The options are IMAGE, VIDEO, and LOCATE.

description

Yes

String

Card description.

redirectUrl

Yes

String

Card link.

mediaFileId

No

String

Multimedia resource ID.

alignment

Yes

String

Card display style. The options are as follows:

  • transverse: horizontal
  • Longitudinal: vertical

cardTemplateType

Yes

String

Template type. The options are 0 (common type) and 1 (card options).

longitude

No

String

Longitude. This parameter is returned only when mediaType is set to LOCATE.

latitude

No

String

Latitude. This parameter is returned only when mediaType is set to LOCATE.

locateName

No

String

Address. This parameter is returned only when mediaType is set to LOCATE.

locateDescription

No

String

Description of an address. This parameter is returned only when mediaType is set to LOCATE.

CardTabs

Yes

String

Card list. For details about the parameters of this object, see Table 4.
Table 4 CardTabs

Parameter

Mandatory or Not

Type

Description

selectcontent

Yes

String

Option content.

displaytext

Yes

String

Card display text.

name

No

String

Image name.

multiMediaId

No

String

Image media resource.

selectType

Yes

String

Option type. The options are as follows:

  • 0: link
  • 2: reply

Example

  • Request 
    POST /service-cloud/rest/webadapter/v1/webadapterfacade/queryWebCardInfoById
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: */*

{"id":"1687431048128159745"}
  • Response 
    {
    "mediaFileId": "1702153781533810690",
    "locateName": "Address 88849",
    "redirectUrl": "",
    "latitude": "23.5",
    "multiMediaId": "1702153781533810690",
    "cardType": 3,
    "description": "Card description 8780",
    "mediaType": "LOCATE",
    "locateDescription": "Address description 839",
    "title": "Card title 4507",
    "CardTabs": [
        {
            "selectcontent": "Reply",
            "displaytext": "Reply",
            "name": "redirectUrl",
            "multiMediaId": "1699978101548609537",
            "selectType": "2"
        },
        {
            "selectcontent": "https://****",
            "displaytext": "Access",
            "name": "",
            "selectType": "0"
        }
    ],
    "name": "Card 1227",
    "cardTemplateType": 0,
    "id": "1702153790505426946",
    "alignment": "transverse",
    "longitude": "23.5"
}
Parent topic: Web Channel