You need to enable JavaScript to run this app.
导航

取消双呼(挂断)

最近更新时间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-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceNameStringvms服务名称。语音服务的服务名称是vms
RegionStringcn-north-1区域名称,固定值cn-north-1

Content-Type

String

application/x-www-form-urlencoded

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/x-www-form-urlencoded

Query

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

Body

参数数据类型是否必填示例值描述
CallIdStringDcc0143d97c773af84077addfdd84f9d861f6通话id,调用呼叫接口后返回
3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error

Result

参数数据类型示例值描述

Result

Boolean

true

成功true,失败false

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
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
}