Obtaining Click-to-Dial Events

Function

This interface is invoked to obtain click-to-dial events based on the channel.

Usage Description

Prerequisites
The web channel configuration has been correctly created.

Interface Prototype

**Table 1** Interface prototype description
Method	GET
URL	https://{IP address}:{Port number}/service-cloud/rest/webadapter/v1/webadapterfacade/getClickToCallEvents	{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

None

Response Parameters

Parameter	Mandatory or Not	Type	Description
resultCode	Yes	String	Interface response code. The value 0 indicates success.
resultDesc	No	String	Interface description.
eventId	No	Number	Event ID.
content	No	Object	Event content.

**Table 3** content parameters
Parameter	Mandatory or Not	Type	Description
domain	No	String	WebRTC gateway domain name of the connection setup success event.
gwAddresses	No	Array	WebRTC gateway communication address and port number of the connection setup success event.
accessCode	No	Number	Click-to-dial access code of the connection setup success event.
clickToCallCaller	No	String	Click-to-dial calling number of the connection setup success event.
causeId	No	Number	CTI platform cause code of the connection setup failure event.
causeDesc	No	String	CTI platform cause description of the connection setup failure event.

Example

Request

GET /service-cloud/rest/webadapter/v1/webadapterfacade/getClickToCallEvents

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

Response

{"resultCode":"0","resultDesc":"Call connected","eventId":168101,"content":{"domain":"xxx","gwAddresses":["xxx"],"accessCode":"xxxx","clickToCallCaller":"xxx"}}

Parent topic: Web Channel

Previous topic: Creating a Click-to-Dial Call

Next topic: Releasing the Current Click-to-Dial Call