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

号码用户停启用

最近更新时间2023.08.17 22:03:19

首次发布时间2023.02.28 20:31:39

批量处理号码限制数量100个

  • 请求方式:POST

  • 接口地址:https://cloud-vms.volcengineapi.com

1. 请求参数
参数数据类型是否必填示例值描述
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

参数数据类型是否必填示例值描述
ActionStringEnableOrDisableNumber接口名称。该接口固定值为EnableOrDisableNumber。
VersionString2022-01-01接口版本。该接口版本为2022-01-01

Body

注意

IdList 和 NumberList 至少有一个不为 Null

名称类型是否必选示例值描述

NumberList

List

17192359307, 17192359308

号码列表

EnableCode

Integer

1

停启用标识
1 启用,2 停用

IdInteger按照id进行启用和停用
NumberString号码
RemarkString备注
IdListStringid列表
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
3. 示例

请求示例

curl --location --request POST '[地址]' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--form 'Action="EnableOrDisableNumber"' \
--form 'Version="2022-01-01"' \
--form 'EnableCode="2"' \
--form 'numberList="13718578349,13718578350,13718578351,13718578352,13718578353"'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202101051619200102251070341B00461A",
        "Action": "EnableOrDisableNumber",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    }
}