Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ Web Channel/ Creating a Click-to-Dial Call
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Creating a Click-to-Dial Call

Function

This interface is invoked to create a click-to-dial call based on the channel configuration.

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

{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

mediaAbility

Yes

String

Click-to-dial media capability. The value can be 0 (voice call) or 1 (video call).

Response Parameters

Parameter

Mandatory or Not

Type

Description

resultCode

Yes

String

Interface response code. The value 0 indicates success.

resultDesc

No

String

Interface description.

Example

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

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

{"mediaAbility":"1"}
  • Response 
    {"resultCode":"0","resultDesc":"connect successfully."}
Parent topic: Web Channel