请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	NumberListScroll	要执行的操作，取值：NumberListScroll。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
Limit	Integer	否	500	单次查询返回的号码数量，默认值为20，默认最大值为500。
QueryAccountId	String	否	2000009999	指定要查询的账号ID。
Number	String	否	13812345678	指定要查询的号码。
NumberList	Array of String	否	13812345678, 13912345678	指定要查询的号码列表。
NumberStatusCode	Integer	否	1	号码状态编码：1 使用中，2 用户停用，3 平台停用，4 已注销，5 未使用，6 平台注销，-1 异常状态。
NumberTypeCode	Integer	否	0	号码类型编码：0 手机号，1 固话，2 AXB手机号，3或4 功能固话，5 700号码。
NumberPoolNo	String	否	NP1234567890	号码池编号。
NumberPoolTypeCode	Integer	否	101	号码池类型编码。
NextToken	String	否	eyJwaXRJZCI6IioqKioqKiJ9	滚动分页凭证。首次查询不传；当上一次响应中HasMore为true时，需在NextTokenExpireAt指定的时间前原样传入上一页响应中的NextToken。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Total	Long	50000	符合查询条件的号码总数量。
Limit	Integer	500	本次查询的分页大小。
Records	Array of Object	无	号码信息列表。
NextToken	String	eyJwaXRJZCI6IioqKioqKiJ9	下一页滚动分页凭证。HasMore为true时返回，下一次查询需原样传入；HasMore为false时不返回。
NextTokenExpireAt	Long	1785732120000	NextToken的过期时间，Unix时间戳，单位为毫秒。HasMore为true时返回。
HasMore	Boolean	true	是否还有下一页数据。true表示还有下一页，false表示已到最后一页。

请求示例

使用说明
首次查询无需传入 NextToken；当响应中的 HasMore 为 true 时，后续查询需原样回传上一页响应中的 NextToken，直至 HasMore 为 false。
滚动查询期间请保持筛选条件不变。NextToken 为服务端生成的不透明凭证，请勿解析或修改，并请在 NextTokenExpireAt 指定的时间前使用；凭证过期后需重新发起首次查询。
接口支持并发调用。同一个 NextToken 表示相同的滚动位置，重复使用可能返回重复数据；每条滚动查询链路应使用上一页返回的最新 NextToken 继续查询。
单次返回数量和请求频率受服务保护策略限制，具体限制以实际服务配置为准。

首次查询：

GET /?Action=NumberListScroll&Version=2022-01-01&Limit=500&NumberPoolNo=NP1234567890 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Date: 20260803T073515Z
X-Content-Sha256: e3b0c44298******b934ca495991b7852b855
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260803/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

后续查询：

GET /?Action=NumberListScroll&Version=2022-01-01&Limit=500&NumberPoolNo=NP1234567890&NextToken=eyJwaXRJZCI6IioqKioqKiJ9 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Date: 20260803T073516Z
X-Content-Sha256: e3b0c44298******b934ca495991b7852b855
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260803/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2026080315352016120516416522C618",
    "Action": "NumberListScroll",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 49999,
    "Limit": 500,
    "Records": [
      {
        "Number": "138****5678",
        "NumberStatusCode": 1,
        "NumberStatusDesc": "使用中",
        "NumberTypeCode": 0,
        "NumberTypeDesc": "手机",
        "NumberLocation": "北京 北京",
        "NumberPurchaseTime": "2020-12-24 19:42:13",
        "NumberPoolNo": "NP1234567890",
        "NumberPoolName": "营销号码池",
        "NumberPoolTypeCode": 101,
        "NumberPoolTypeDesc": "语音SIP",
        "ServiceTypeCode": 100,
        "ServiceTypeDesc": "普通号码",
        "QualificationNo": "QUA160103629101915830",
        "CurrentBindCount": 1
      }
    ],
    "NextToken": "eyJwaXRJZCI6IioqKioqKiJ9",
    "NextTokenExpireAt": 1785732120000,
    "HasMore": true
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	SystemError	系统错误
200	InternalServiceFailed	The internal service error

最近更新时间：2026.08.06 20:58:14

这个页面对您有帮助吗？

有用

无用

语音服务

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

返回参数

请求示例

返回示例

错误码