调用QuerySecretNoRemain查询线上可购号码余量_号码隐私保护-阿里云帮助中心

查询线上可购号码余量。

接口说明

购买号码时，指定归属地如果没有足够号码可供购买，会造成号码购买失败。调用接口BuySecretNo购买号码前，请先通过接口QuerySecretNoRemain查询线上可购号码余量。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SpecId	long	是	号码类型。取值： 1：虚商号码，即170或171。 2：运营商号码。 3：95号码。	1
City	string	是	号码的归属地。 SpecId设置为1或2时，可以在参数City中指定查询支持输入单个城市名称查询。支持输入“全国”查询，可返回全国可购号码余量。支持输入“全国列表”查询，将返回全国城市中有号码的城市及数量，无号码的城市不会返回。 SpecId设置为3时，95号码不区分归属地，只能查询全部95号码可购余量，即必须指定City为全国通用。说明当前仅支持设置归属地为中国大陆地区。	杭州
SecretNo	string	否	号码前缀。查询可购号码余量时，如果指定SecretNo，表示查询指定前缀的号码余量。最长可指定18位号码前缀。	130

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	string	请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求ID。	9FC30594-3841-43AD-9008-03393BCB5CD2
SecretRemainDTO	object	接口调用成功后返回的结构体。
Amount	long	可购号码余量。	0
City	string	号码的归属地。	杭州
RemainDTOList	array	可购号码余量列表。
	object	结构体。
Amount	long	城市可购号码余量。	120
City	string	号码的归属地。	武汉

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "9FC30594-3841-43AD-9008-03393BCB5CD2",
  "SecretRemainDTO": {
    "Amount": 0,
    "City": "杭州",
    "RemainDTOList": {
      "remainDTO": [
        {
          "Amount": 120,
          "City": "武汉"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。