Help Center/ Cognitive Engagement Center/ User Access--Web Client Access (RESTful)/ Get Click-to-dial Event/ GET /ccmessaging/v1/getClickToCallEvents
Updated on 2024-03-05 GMT+08:00
View PDF
Share

GET /ccmessaging/v1/getClickToCallEvents

Description

get ClickToCall Events

Method

GET

URI

https://Domain Name/apiaccess/ccmessaging/v1/getClickToCallEvents,the domain name is service.besclouds.com.

Request

Table 1 Query Parameters

Seq.

Name

Type

Mandatory

Description

1

channel

string

True

channel type" WEB"
Table 2 Header Parameters

Seq.

Name

Type

Mandatory

Description

1

ccmessaging-token

string

True

ccmessagign-token generated by the applyToken interface

2

x-app-key

string

True

The same as app_key, which uniquely identifies a user

3

Authorization

string

True

Authentication field. The value format is as follows: Bearer +AccessToken in the return values of the tokenByAKSK interface (there is a space after Bearer)

Response

  • Status code: 200
Table 3 Body Parameters

Seq.

Name

Type

Mandatory

Description

1.1

resultCode

string

False

result Code

1.2

resultDesc

string

False

result description

1.3

eventId

string

False

event Id

1.4

content

object

False

content

1.4.1

causeDesc

string

False

cause description

1.4.2

causeId

string

False

cause id

1.4.3

accessCode

string

False

access Code

1.4.4

domain

string

False

webRTC domain

1.4.5

gwAddresses

array

False

webRTC gateway address

1.4.6

clickToCallCaller

string

False

Caller
  • Status code: 400

    Incorrect request: Check the request path and parameters.

  • Status code: 401

    Unauthorized: 1. Check whether you have purchased related services. 2. Contact customer service personnel to check the current status of your account.

  • Status code: 404

    Request content not found: Check the path of the request.

  • Status code: 500

    Business failure: Check the values of the parameters in the request.

Error Code

None.

Message Example

  • Scene description:get create call event

    URL:get create call event

    Request Header:

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

    Request Parameter:

    /apiaccess/ccmessaging/getClickToCallEvents?channel=WEB

    Response Parameter:

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

Parent topic: Get Click-to-dial Event