最近更新时间：2023.08.17 22:03:24
首次发布时间：2023.02.28 20:31:39
查询号码最大数量为500
请求方式：GET
接口地址：https://cloud-vms.volcengineapi.com
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| X-Date | String | 是 | 20201103T104027Z | 鉴权字段。请参考文档中心-火山引擎。 |
Authorization | String | 是 | HMAC-SHA256 Credential*** | 鉴权字段。请参考文档中心-火山引擎。 |
| ServiceName | String | 是 | vms | 服务名称。语音服务是vms。 |
| Region | String | 是 | cn-north-1 | 区域名称，固定值cn-north-1。 |
Content-Type | String | 是 | application/x-www-form-urlencoded | 指定请求消息体的结构化格式。语音服务的 Content-Type 为 |
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | NumberList | 接口名称。该接口固定值为NumberList。 |
| Version | String | 是 | 2022-01-01 | 接口版本。该接口版本为2022-01-01 |
| Number | String | 否 | 17192359301 | 号码 |
| NumberPoolNo | String | 否 | NP160932049201918457 | 号码池编号 |
| NumberPoolTypeCode | Integer | 否 | 101 | 号码池类型 ，参考枚举-子服务类型 |
NumberStatusCode | Integer | 否 | 1 | 号码状态 |
NumberTypeCode | Integer | 否 | 0 | 号码类型 |
| Limit | Integer | 否 | 20 | 每页大小，默认值20 |
| Offset | Long | 否 | 0 | 每页偏移量 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
| Result | Result | 响应业务参数。包含的参数说明请参见 Result。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | String | 请求 ID。 |
| Action | String | 请求的接口名称。 |
| Version | String | 请求的版本号。 |
| Service | String | 请求的服务名称。 |
| Region | String | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Number | String | 17192359301 | 号码 |
NumberStatusCode | Integer | 4 | 号码状态 |
| NumberStatusDesc | String | 已注销 | 号码状态 |
NumberTypeCode | Integer | 0 | 号码类型 |
| NumberTypeDesc | String | 手机 | 号码类型描述 |
| NumberLocation | String | 北京 北京 | 号码归属地 |
| NumberPurchaseTime | String | 2020-12-24 19:42:13 | 号码购买时间 |
| NumberPoolNo | String | NP160103629101915830 | 号码池编号 |
| NumberPoolName | String | 我的号码池 | 号码池名称 |
| NumberPoolTypeCode | Integer | 101 | 号码池类型（参考 枚举-子服务类型） |
| NumberPoolTypeDesc | String | 语音sip | 号码池类型描述 |
| ServiceTypeCode | Integer | 100 | 服务类型，参考 枚举-服务类型 |
| ServiceTypeDesc | String | 普通号码 | 服务类型描述，参考 枚举-服务类型 |
| QualificationNo | String | QUA160103629101915830 | 资质编号 |
| QualificationEntity | String | 北京字节跳动科技有限公司 | 资质主体 |
| Limit | Integer | 1 | 页大小，默认值20 |
| Offset | Integer | 0 | 偏移量 |
| Total | Integer | 32 | 结果总数 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | String | 错误码。 |
| Message | String | 错误信息。 |
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 } }