Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ Web Channel/ Querying Information About a Resource in the Online Chat Multimedia Library
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Information About a Resource in the Online Chat Multimedia Library

Function

This interface is invoked to query information about a resource in the online chat multimedia library.

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

{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

ID of the multimedia library resource file.

Response Parameters

Parameter

Mandatory or Not

Type

Description

id

Yes

String

ID of the multimedia library resource file.

parentTypeId

Yes

String

ID of the type to which the multimedia library resource file belongs.

mediaUrl

Yes

String

Key of the multimedia library resource file.

mediaType

Yes

String

Type of the multimedia library resource file. The value can be AUDIO, VIDEO, IMAGE, DOCUMENT, LOCATE, EMOTIONS, RICHTEXT, or CARD.

name

Yes

String

Name of a multimedia library resource file.

description

No

String

Description of the multimedia library resource file.

fileName

No

String

File name.

fileSize

No

String

File size.

sizeUnit

No

String

File size unit. The options are KB and MB.

duration

No

String

Duration of a voice or video file.

latitude

No

String

Latitude of a location.

longitude

No

String

Longitude of a location.

mediaFileType

No

String

File name extension of a multimedia file, which can be jpeg, png, mp3, or mp4.

content

No

String

Content of a rich text file.

Example

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

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": "1628942119960686593"
}
  • Response 
    {
    "id": "1628942119960686593",
    "parentTypeId": "default_document",
    "mediaUrl": "878e7d9a-8e2f-4893-8b54-352f8ecbf86c",
    "mediaType": "DOCUMENT",
    "name": "testZip",
    "description": "haha",
    "fileName": "testZip.zip",
    "fileSize": "0.13",
    "sizeUnit": "MB",
    "duration": null,
    "latitude": null,
    "longitude": null
}
Parent topic: Web Channel