调用接口QuerySecretNoRemain查询线上可购号码余量。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
City String 杭州

号码的归属地。

  • SpecId设置为1或2时,可以在参数City中指定查询

1. 支持输入单个城市名称查询。

2. 支持输入“全国”查询,可返回全国可购号码余量。

3. 支持输入“全国列表”查询,将返回全国城市中有号码的城市及数量,无号码的城市不会返回。

  • SpecId设置为3时,95号码不区分归属地,只能查询全部95号码可购余量,即必须指定City全国通用
说明 当前仅支持设置归属地为中国大陆地区。
SpecId Long 1

号码类型。其中:

  • 1表示虚商号码,即170或171。
  • 2表示运营商号码。
  • 3表示95号码。
AccessKeyId String LTAIP00vvvvvvvvv

主账号AccessKey的ID。

Action String QuerySecretNoRemain

系统规定参数。取值:QuerySecretNoRemain

SecretNo String 130

号码前缀。查询可购号码余量时,如果指定SecretNo,表示查询指定前缀的号码余量。

最长可指定18位号码前缀。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

Message String OK

状态码的描述。

RequestId String 9FC30594-3841-43AD-9008-03393BCB5CD2

请求ID。

SecretRemainDTO

接口调用成功后返回的结构体。

Amount Long 0

可购号码余量。

City String 杭州

号码的归属地。

RemainDTOList

可购号码余量列表。

Amount Long 120

可购号码余量。

City String 武汉

号码的归属地。

示例

请求示例


http(s)://[Endpoint]/?City=杭州
&SpecId=1
&<公共请求参数>

正常返回示例

XML 格式

<QuerySecretNoRemainResponse>	
      <SecretRemainDTO>
		    <Amount>0</Amount>
		    <City>杭州</City>
	  </SecretRemainDTO>
	  <Message>OK</Message>
	  <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>
	  <Code>OK</Code>
</QuerySecretNoRemainResponse>

JSON 格式

{
	"SecretRemainDTO":{
		"Amount":0,
		"City":"杭州"
	},
	"Message":"OK",
	"RequestId":"9FC30594-3841-43AD-9008-03393BCB5CD2",
	"Code":"OK"
}

错误码

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