You need to enable JavaScript to run this app.
导航
号码申请记录列表查询
最近更新时间:2024.03.07 16:26:28首次发布时间:2023.02.28 20:31:39
  • 请求方式: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

参数数据类型是否必填示例值描述
ActionStringQueryNumberApplyRecordList接口名称。该接口固定值为QueryNumberApplyRecordList。
VersionString2022-01-01接口版本。该接口版本为2022-01-01
ApplyBillIdStringNA0612859102申请单id
QueryAccountIdString324543645客户id
ApplyStatusCodeInteger1申请单状态(1-已提交,2-受理中, 3-购买成功,4-购买失败,5-部分成功)
ApplyTimeLowerBoundString2022-11-24 00:00:00申请时间下限
ApplyTimeUpperBoundString2022-12-22 23:59:59申请时间上限
SubServiceTypeInteger101参考 枚举-子服务类型
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

名称类型示例值描述
IdInteger3545唯一id
ApplyTimeString2022-02-18 14:41:48申请时间
ApplyStatusCodeInteger3申请状态编码,1-已提交、2-受理中、3-购买成功、4-购买失败、5-部分成功
ApplyStatusDescString购买成功申请状态描述

SubServiceTypeCode

Integer

101

号码归属服务,参考枚举-子服务类型

SubServiceTypeDescString语音SIP号码归属服务
NumberPoolNoStringNP164015715228226293号码所属号码池
NumberPoolNameString语音SIP默认号码池号码所属号码池名称

NumberTypeCode

Integer

1

号码类型(0 手机,1 固话)

NumberTypeDescString固话号码类型
ApplyUserIdString2100042822号码申请人
ApplyUserNameString""号码申请人
UpdateTimeString2022-02-18 14:41:48号码申请更新时间
NotesString""号码申请备注
NumberLocationString北京市/北京城区号码归属地
ApplyNumberCountInteger100号码申请数量
ImportNumberCountInteger100号码导入数量
ApplyBillIdStringNA5088572207号码申请单id
QualificationIdInteger345资质id
QualificationEntityString奇迹投资公司资质主体
LimitInteger20分页参数-返回条数
OffsetInteger0分页参数-偏移量
TotalInteger30分页参数-总数

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="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
    }
}