QuerySubscription - 查询订阅关系--语音服务-火山引擎

文档中心

立即注册

语音服务

隐私号

QuerySubscription - 查询订阅关系

根据绑定关系ID和号码池编号查询绑定关系详细信息

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QuerySubscription	要执行的操作，取值：QuerySubscription。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
NumberPoolNo	String	是	NP16000000000000	X号码所在的号码池编号
SubId	String	是	S160817372431590000	绑定关系ID

返回参数

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

参数	类型	示例值	描述
SubId	String	S160817372431596661	绑定关系ID
PhoneNoA	String	17000000000	A号码
PhoneNoB	String	17000000001	B号码
PhoneNoX	String	17000000002	X号码
PhoneNoY	String	17000000009	Y号码
Status	Integer	1	绑定关系状态 0已解绑，1已绑定，2绑定异常
RecordFlag	Integer	1	是否需要录音 0：关闭，1 : 开启（默认开启）
EnableTime	Long	1608196519	生效时间
ExpireTime	Long	1608209071	过期时间（以秒为单位的时间戳，必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00）
CallDisplayType	Integer	1	是否透传 1：不透传，2：A看见B的真实号码，3：B看见A的真实号码，4：看见对方真实号码
CallDisplayTypeName	String	不透传	透传类型描述：不透传，A看见B的真实号码，B看见A的真实号码，看见对方真实号码
UserData	String	abcdef	用户拓展参数，最大长度为2048
OutId	String	123456	外部业务id，最大长度128位
PhoneNoE	String	17000000008	E号码

请求示例

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

{
  "NumberPoolNo": "NP16000000000000",
  "SubId": "S160817372431590000"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250317212243154034119043B238E9",
    "Action": "QuerySubscription",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "SubId": "S160817372431596661",
    "ParentSubId": "S160817372431596660",
    "PhoneNoA": "17000000000",
    "PhoneNoB": "17000000001",
    "PhoneNoX": "17000000002",
    "PhoneNoY": "17000000002",
    "Status": 1,
    "RecordFlag": 1,
    "EnableTime": "1608196519",
    "ExpireTime": "1608209071",
    "CallDisplayType": 1,
    "CallDisplayTypeName": "不透传",
    "UserData": "oq0",
    "OutId": "8A6T",
    "PhoneNoE": "17000000008"
  }
}

错误码

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

状态码	错误码	错误信息
200	SystemError	系统错误
200	UnauthenticatedRequest	未登录的请求
200	IllegalArgument	非法的参数

最近更新时间：2025.07.11 17:27:25

这个页面对您有帮助吗？

有用

无用