Obtaining a Click-to-Dial Event (getClickToCallEvents)

Scenario

This interface is invoked to obtain a click-to-dial event.

Method

GET

URI

https://Domain name/apiaccess/ccmessaging/v1/getClickToCallEvents (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Query parameter
No.	Parameter	Type	Mandatory or Not	Description
1	channel	String	Yes	Recipient channel type (WEB)

**Table 2** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	ccmessaging-token	String	Yes	Value of ccmessaging-token generated by the applyToken interface
2	x-app-key	String	Yes	App key, which is the user ID and is configured on the API Fabric
3	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	resultCode	String	No	Response result code
1.2	resultDesc	String	No	Response result description If resultCode is 0, the description is Call in queue, Call connected, Call disconnected, Call queued timeout, Call failed, Call continue to poll events with unknown events, or ClickToCall polled without any events.
1.3	eventId	String	No	Event ID
1.4	content	Object	No	Event content
1.4.1	causeDesc	String	No	Cause description
1.4.2	causeId	String	No	Cause ID
1.4.3	accessCode	String	No	Click-to-dial called party
1.4.4	domain	String	No	WebRTC gateway domain name
1.4.5	gwAddresses	array	No	WebRTC gateway communication address and port number
1.4.6	clickToCallCaller	String	No	Click-to-dial calling party

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request header:

ccmessaging-token:  
x-app-key:  
Authorization:

Request parameters:
None

Response parameters:

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

Parent topic: Web Client Access Interface Reference

Previous topic: Creating a Click-to-Dial Call (createClickToCall)

Next topic: Releasing a Click-to-Dial Call (dropClickToCall)