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

编辑号码池

最近更新时间2023.08.17 22:02:57

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

  • 请求方式: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

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

Body

名称类型是否必选示例值描述
NumberPoolNoStringNP160932049201918457号码池编号
NameString我的号码池号码池名称
ServiceTypeInteger100参考 枚举-服务类型
SubServiceTypeInteger101参考 枚举-子服务类型
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

bool类型 true-更新成功,false更新失败

Error

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

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--form 'Action="UpdateNumberPool"' \
--form 'Version="2022-01-01"' \
--form 'Name="TestNumberPoolName2"' \
--form 'ServiceType="200"' \
--form 'SubServiceType="201"' \
--form 'NumberPoolNo="NP160932049201918457"'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2020123017574301022510703406017B7F",
        "Action": "UpdateNumberPool",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": true
}