取消双呼（挂断）--语音服务-火山引擎

文档中心

立即注册

导航

取消双呼（挂断）

最近更新时间：2023.08.17 21:00:34首次发布时间：2023.02.28 20:31:38

调用CancelClick2Call接口取消双呼，系统将主叫、被叫挂机，双方通话结束。

1. 接口说明

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com?Action=CancelClick2Call&Version=2022-01-01

2. 请求参数

参数	数据类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称是`vms`。
Region	String	是	cn-north-1	区域名称，固定值`cn-north-1`。
Content-Type	String	是	application/x-www-form-urlencoded	指定请求消息体的结构化格式。语音服务的 Content-Type 为`application/x-www-form-urlencoded`。

Query

参数	数据类型	是否必填	示例值	描述
Action	String	是	CancelClick2Call	接口名称。该接口固定值为`CancelClick2Call`。
Version	String	是	2022-01-01	接口版本。语音服务接口默认版本为`2022-01-01`。

Body

参数	数据类型	是否必填	示例值	描述
CallId	String	是	Dcc0143d97c773af84077addfdd84f9d861f6	通话id，调用呼叫接口后返回

3. 返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见 ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数	数据类型	描述
RequestId	String	请求 ID。
Action	String	请求的接口名称。
Version	String	请求的版本号。
Service	String	请求的服务名称。
Region	String	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数	数据类型	示例值	描述
Result	Boolean	true	成功true，失败false

Error

参数	数据类型	描述
Code	String	错误码。
Message	String	错误信息。

4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=CancelClick2Call&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-urlencode 'CallId=Dcc0143d97c773af84077addfdd84f9d861'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20201217105523010225107093230085E8",
        "Action": "CancelClick2Call",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": true
}

语音服务

Header

Query

Body

ResponseMetadata

Result

Error

请求示例

返回示例