文档首页/ 云客服/ API参考/ 网页客户端接入/ 检查当前租间是否支持点击通话 (checkClickToCallSupport)
更新时间:2023-09-27 GMT+08:00

检查当前租间是否支持点击通话 (checkClickToCallSupport)

场景描述

检查是否支持点击通话

接口方法

GET

接口URI

https://域名/apiaccess/ccmessaging/v1/checkClickToCallSupport,例如域名是service.besclouds.com

请求说明

表1 查询参数

序号

名称

参数类型

是否必选

说明

1

channel

string

True

接收者渠道类型(WEB)

表2 请求头参数

序号

名称

参数类型

是否必选

说明

1

ccmessaging-token

string

True

applyToken接口生成的ccmessagign-token

2

x-app-key

string

True

appKey字段,用户标识,在API Fabric上配置

3

Authorization

string

True

鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

webRTCSupported

boolean

False

WebRTC是否支持

1.2

clickToCallSupported

boolean

False

点击通话是否支持

1.3

resultCode

string

False

响应结果码

1.4

resultDesc

string

False

响应结果描述

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述:检查是否支持点击通话

    URL:https://域名/apiaccess/ccmessaging/v1/checkClickToCallSupport

    请求头:

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

    请求参数:

    {
    	"channel": "WEB"
    }

    响应参数:

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