You need to enable JavaScript to run this app.
导航
查询号码列表
最近更新时间:2023.08.17 22:03:24首次发布时间:2023.02.28 20:31:39

查询号码最大数量为500

  • 请求方式:GET

  • 接口地址: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

参数数据类型是否必填示例值描述
ActionStringNumberList接口名称。该接口固定值为NumberList。
VersionString2022-01-01接口版本。该接口版本为2022-01-01
NumberString17192359301号码
NumberPoolNoStringNP160932049201918457号码池编号
NumberPoolTypeCodeInteger101号码池类型 ,参考枚举-子服务类型

NumberStatusCode

Integer

1

号码状态
1 使用中,2 用户停用,3 平台停用,4 已注销

NumberTypeCode

Integer

0

号码类型
0 手机,1 固话

LimitInteger20每页大小,默认值20
OffsetLong0每页偏移量
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

名称类型示例值描述
NumberString17192359301号码

NumberStatusCode

Integer

4

号码状态
1 使用中,2 用户停用,3 平台停用,4 已注销

NumberStatusDescString已注销号码状态

NumberTypeCode

Integer

0

号码类型
0 手机,1 固话

NumberTypeDescString手机号码类型描述
NumberLocationString北京 北京号码归属地
NumberPurchaseTimeString2020-12-24 19:42:13号码购买时间
NumberPoolNoStringNP160103629101915830号码池编号
NumberPoolNameString我的号码池号码池名称
NumberPoolTypeCodeInteger101号码池类型(参考 枚举-子服务类型)
NumberPoolTypeDescString语音sip号码池类型描述
ServiceTypeCodeInteger100服务类型,参考 枚举-服务类型
ServiceTypeDescString普通号码服务类型描述,参考 枚举-服务类型
QualificationNoStringQUA160103629101915830资质编号
QualificationEntityString北京字节跳动科技有限公司资质主体
LimitInteger1页大小,默认值20
OffsetInteger0偏移量
TotalInteger32结果总数

Error

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

请求示例

curl --location --request GET '[地址]' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--form 'Action="NumberList"' \
--form 'Version="2022-01-01"' \
--form 'NumberPoolNo="NP160102206401913945"' \
--form 'Limit="1"' \
--form 'Offset="0"'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202012302006250102251070340005C99C",
        "Action": "QueryNumberList",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "Records": [
            {
                "Id": 279,
                "Number": "13718578339",
                "NumberStatusCode": 4,
                "NumberStatusDesc": "已注销",
                "NumberTypeCode": 0,
                "NumberTypeDesc": "手机",
                "NumberLocation": "北京北京",
                "NumberPurchaseTime": "2020-12-24 19:45:32",
                "NumberPoolNo": "NP160102206401913945",
                "NumberPoolName": "2jjo",
                "NumberPoolTypeCode": 201,
                "NumberPoolTypeDesc": "AXB",
                "ServiceTypeCode": 200,
                "ServiceTypeDesc": "隐私号码"
            }
        ],
        "Limit": 1,
        "Offset": 0,
        "Total": 32
    }
}