最近更新时间：2024.03.07 16:26:28
首次发布时间：2023.02.28 20:31:39
请求方式：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 | 是 | QueryNumberApplyRecordList | 接口名称。该接口固定值为QueryNumberApplyRecordList。 |
| Version | String | 是 | 2022-01-01 | 接口版本。该接口版本为2022-01-01 |
| ApplyBillId | String | 否 | NA0612859102 | 申请单id |
| QueryAccountId | String | 否 | 324543645 | 客户id |
| ApplyStatusCode | Integer | 否 | 1 | 申请单状态（1-已提交，2-受理中， 3-购买成功，4-购买失败，5-部分成功） |
| ApplyTimeLowerBound | String | 否 | 2022-11-24 00:00:00 | 申请时间下限 |
| ApplyTimeUpperBound | String | 否 | 2022-12-22 23:59:59 | 申请时间上限 |
| SubServiceType | Integer | 否 | 101 | 参考 枚举-子服务类型 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
| Result | Result | 响应业务参数。包含的参数说明请参见 Result。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | String | 请求 ID。 |
| Action | String | 请求的接口名称。 |
| Version | String | 请求的版本号。 |
| Service | String | 请求的服务名称。 |
| Region | String | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Integer | 3545 | 唯一id |
| ApplyTime | String | 2022-02-18 14:41:48 | 申请时间 |
| ApplyStatusCode | Integer | 3 | 申请状态编码，1-已提交、2-受理中、3-购买成功、4-购买失败、5-部分成功 |
| ApplyStatusDesc | String | 购买成功 | 申请状态描述 |
SubServiceTypeCode | Integer | 101 | 号码归属服务，参考枚举-子服务类型 |
| SubServiceTypeDesc | String | 语音SIP | 号码归属服务 |
| NumberPoolNo | String | NP164015715228226293 | 号码所属号码池 |
| NumberPoolName | String | 语音SIP默认号码池 | 号码所属号码池名称 |
NumberTypeCode | Integer | 1 | 号码类型（0 手机，1 固话） |
| NumberTypeDesc | String | 固话 | 号码类型 |
| ApplyUserId | String | 2100042822 | 号码申请人 |
| ApplyUserName | String | "" | 号码申请人 |
| UpdateTime | String | 2022-02-18 14:41:48 | 号码申请更新时间 |
| Notes | String | "" | 号码申请备注 |
| NumberLocation | String | 北京市/北京城区 | 号码归属地 |
| ApplyNumberCount | Integer | 100 | 号码申请数量 |
| ImportNumberCount | Integer | 100 | 号码导入数量 |
| ApplyBillId | String | NA5088572207 | 号码申请单id |
| QualificationId | Integer | 345 | 资质id |
| QualificationEntity | String | 奇迹投资公司 | 资质主体 |
| Limit | Integer | 20 | 分页参数-返回条数 |
| Offset | Integer | 0 | 分页参数-偏移量 |
| Total | Integer | 30 | 分页参数-总数 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | String | 错误码。 |
| Message | String | 错误信息。 |
curl --location --request POST '[地址]' \ --header 'ServiceName: vms' \ --header 'Region: cn-north-1' \ --header 'X-Date: 20201103T104027Z' \ --header 'Authorization: HMAC-SHA256 Credential=***' \ --form 'Action="QueryNumberApplyRecordList"' \ --form 'Version="2022-01-01"' \ --form 'ApplyBillId="NA5088572207"' \ --form 'ApplyStatusCode="1"' \ --form 'SubServiceType="201"'
{ "ResponseMetadata": { "RequestId": "20201230172812010225107034190083F8", "Action": "QueryNumberApplyRecordList", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1" }, "Result": { "Records": [ { "Id": 5944, "ApplyTime": "2022-02-18 14:41:48", "ApplyStatusCode": 3, "ApplyStatusDesc": "购买成功", "SubServiceTypeCode": 101, "SubServiceTypeDesc": "语音SIP", "NumberPoolNo": "NP164015715228226293", "NumberPoolName": "语音SIP默认号码池", "NumberTypeCode": 1, "NumberTypeDesc": "固话", "ApplyUserId": "2100042822", "ApplyUserName": "", "UpdateTime": "2022-02-18 14:41:48", "Notes": "1", "DetailList": [ { "NumberLocation": "北京市/北京城区", "ApplyNumberCount": 100, "ImportNumberCount": 100 } ], "ApplyBillId": "NA5088572207", "QualificationId": 4155, "QualificationEntity": "11111" } ], "Limit": 20, "Offset": 0, "Total": 182 } }