取消单次发送（SingleCancel）--语音服务-火山引擎

文档中心

立即注册

导航

取消单次发送（SingleCancel）

最近更新时间：2023.08.17 20:59:45首次发布时间：2023.02.28 20:31:38

取消单次发送（SingleCancel）

取消单次任务

接口说明

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

请求参数

Header

参数	数据类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。

Query

参数	数据类型	是否必填	示例值	描述
Action	String	是	SingleCancel	接口名称。该接口固定值为`SingleCancel`。
Version	String	是	2022-01-01	接口版本。
SingleOpenId	String	是	123	单次发送openId

返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	见 ResponseMetadata
Result	Result	见下方

Result

参数	数据类型	示例值	描述
SingleOpenId	String	123	单次发送OpenId

请求示例

https://cloud-vms.volcengineapi.com?Action=SingleCancel&Version=2022-01-01&SingleOpenId=189125355526

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221229191646429604DE3BCB1542F945",
        "Action": "QuerySingleInfo",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "SingleOpenId": "189125355526"
    }
}