NumberList - 查询号码列表--语音服务-火山引擎

文档中心

立即注册

导航

NumberList - 查询号码列表

最近更新时间：2025.07.11 17:27:22首次发布时间：2025.07.11 17:27:22

号码页分页查询

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	NumberList	要执行的操作，取值：NumberList。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
NumberList	Array of String	否	13812345678	查询号码列表
NumberStatusCode	Integer	否	1	号码状态 1 使用中，2 用户停用，3 平台停用，4 已注销
NumberPoolNo	String	否	NP1234	号码池编号
NumberPoolTypeCode	Integer	否	101	号码池类型，参考枚举-子服务类型
NumberTypeCode	Integer	否	1	号码类型 0 手机，1 固话
Limit	Integer	否	20	每页大小，默认值20
Offset	Integer	否	0	偏移量

返回参数

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

参数	类型	示例值	描述
Records	Array of Object	无	号码实体
Limit	Integer	1	分页数量
Offset	Integer	10	偏移量
Total	Integer	123	总量

请求示例

POST /?Action=NumberList&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250605T074147Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250605/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Number": "13812345678",
  "NumberPoolNo": "NP1234",
  "NumberPoolTypeCode": 101,
  "NumberStatusCode": "1",
  "NumberTypeCode": 1,
  "Limit": 20,
  "Offset": 0
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202506051541530862241051178BBBE8",
    "Action": "NumberList",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Records": [
      {
        "Number": "138xxxx1234",
        "NumberStatusCode": 4,
        "NumberStatusDesc": "已注销",
        "NumberTypeCode": 0,
        "NumberTypeDesc": "手机",
        "NumberLocation": "北京北京",
        "NumberPoolNo": "NP160103629101915830",
        "NumberPoolName": "我的号码池",
        "NumberPoolTypeCode": 101,
        "NumberPoolTypeDesc": "语音sip",
        "ServiceTypeCode": 100,
        "ServiceTypeDesc": "普通号码",
        "NumberPurchaseTime": "2020-12-24 19:42:13",
        "QualificationNo": "QUA123456",
        "CurrentBindCount": 847
      }
    ],
    "Limit": 1,
    "Offset": 10,
    "Total": 123
  }
}

错误码

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

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