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

GET /ccmessaging/v1/checkClickToCallSupport

Description

check if it supports 'click to call'

Method

GET

URI

https://Domain Name/ccmessaging/v1/checkClickToCallSupport,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

webRTCSupported

boolean

False

if it supports WebRTC

1.2

clickToCallSupported

boolean

False

if it supports 'click to call'

1.3

resultCode

string

False

resultCode

1.4

resultDesc

string

False

resultDesc
  • 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:check if it supports click to call

    URL:check if it supports click to call

    Request Header:

    ccmessaging-token x-app-key Authorization

    Request Parameter:

    /apiaccess/ccmessaging/checkClickToCallSupport?channel=WEB

    Response Parameter:

    { "resultCode":"0", "resultDesc": "", "webRTCSupported":true, "clickToCallSupported":true}