调用GetSubscriptionDetail获取隐私号码状态。
QPS限制
本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | GetSubscriptionDetail |
系统规定参数。取值:GetSubscriptionDetail。 |
PoolKey | String | 是 | FC2256**** |
号码池Key。 请登录号码隐私保护控制台,在号码池管理中查看号码池Key。 |
SubsId | Long | 是 | 100002130961**** |
绑定关系ID。 |
SecretNo | String | 是 | 1300000**** |
隐私号。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK |
请求状态码。
|
Message | String | OK |
状态码的描述。 |
RequestId | String | F655A8D5-B967-440B-8683-DAD6FF8DE990 |
请求ID。 |
Data | Object |
查询成功后返回的结构体。 |
|
PhoneNo | String | 1310000**** |
绑定手机号。 |
City | String | 深圳 |
城市。 |
SwitchStatus | Integer | 1 |
隐私号开关机状态。
|
SubsId | Long | 100002130961**** |
绑定关系ID。 |
SecretNo | String | 1300000**** |
隐私号。 |
Vendor | String | 2 |
归属运营商。 |
Province | String | 广东 |
省份。 |
示例
请求示例
http(s)://dyplsapi.aliyuncs.com/?Action=GetSubscriptionDetail
&PoolKey=FC2256****
&SecretNo=1300000****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetSubscriptionDetailResponse>
<Code>OK</Code>
<Message>OK</Message>
<RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>
<Data>
<PhoneNo>1310000****</PhoneNo>
<City>深圳</City>
<SwitchStatus>1</SwitchStatus>
<SecretNo>1300000****</SecretNo>
<Vendor>2</Vendor>
<Province>广东</Province>
</Data>
</GetSubscriptionDetailResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "OK",
"Message" : "OK",
"RequestId" : "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"Data" : {
"PhoneNo" : "1310000****",
"City" : "深圳",
"SwitchStatus" : 1,
"SecretNo" : "1300000****",
"Vendor" : "2",
"Province" : "广东"
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | isp.SYSTEM_ERROR | A system error occurred. | isp.SYSTEM_ERROR |
400 | PoolKeyNotFound | The specified poolKey does not exist. | 号池不存在 |
访问错误中心查看更多错误码。