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

Sending Messages

Function

This interface is invoked to send messages to agents.

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

{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

controlType

Yes

String

Message control type. The options are CONNECT, DISCONNECT, CHAT, and TRANS2AGENT.

mediaType

Yes

String

Multimedia type. The options are TEXT, IMAGE, VIDEO, and AUDIO.

content

Yes

String

Message content.

userAgent

Yes

String

User environment information.

Response Parameters

Parameter

Mandatory or Not

Type

Description

resultCode

Yes

String

Interface response code. The value 0 indicates success.

resultDesc

Yes

String

Interface description.

Example

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

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

{"controlType":"CONNECT","mediaType":"TEXT","content":"","userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"}
  • Response 
    {"resultCode":"xxx","resultDesc":"xxxx"}
Parent topic: Web Channel