QuerySubscriptionForList - 查询订阅关系列表--语音服务-火山引擎

文档中心

立即注册

导航

QuerySubscriptionForList - 查询订阅关系列表

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

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QuerySubscriptionForList	要执行的操作，取值：QuerySubscriptionForList。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
Status	Integer	否	0	绑定状态，0为已解绑，1为已绑定
NumberPoolNo	String	否	NP160084061100694433	号码池编号
SubId	String	否	S160817372431596661	绑定关系 ID
PhoneNoA	String	否	13700000001	A 号码，可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符，例如 02131075869
Offset	Integer	否	0	偏移量
PhoneNoB	String	否	13700000002	B 号码，可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符，例如 02131075869
Limit	Integer	否	20	每页大小，默认值20
PhoneNoX	String	否	13700000000	X 号码
PhoneNoY	String	否	13700000003	Y 号码
OutId	String	否	45354657	外部业务 id，最大长度 128 位

返回参数

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

参数	类型	示例值	描述
Records	Array of Object	[ { "SubId": "S160817372431596661", "PhoneNoA": "17000000000", "PhoneNoB": "17000000001", "PhoneNoX": "17000000002", "PhoneNoY": "17000000002", "Status": 1, "RecordFlag": 1, "EnableTime": "1608196519", "ExpireTime": "1608209071", "CallDisplayType": 1, "CallDisplayTypeName": "不透传", "UserData": "WR7Vt", "OutId": "pcnY", "PhoneNoE": "17000000008" } ]	绑定关系实体
Limit	Integer	1	分页数量
Offset	Integer	10	偏移量
Total	Integer	123	总量

请求示例

POST /?Action=QuerySubscriptionForList&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250603T110740Z
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": "NP160084061100694433",
  "SubId": "S160817372431596661",
  "PhoneNoA": "13700000001",
  "PhoneNoB": "13700000002",
  "PhoneNoX": "13700000000",
  "PhoneNoY": "13700000003",
  "OutId": "45354657"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250603190745247200132231EFA949",
    "Action": "QuerySubscriptionForList",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Records": [
      {
        "SubId": "S160817372431596661",
        "PhoneNoA": "17000000000",
        "PhoneNoB": "17000000001",
        "PhoneNoX": "17000000002",
        "PhoneNoY": "17000000002",
        "Status": 1,
        "RecordFlag": 1,
        "EnableTime": "1608196519",
        "ExpireTime": "1608209071",
        "CallDisplayType": 1,
        "CallDisplayTypeName": "不透传",
        "UserData": "WR7Vt",
        "OutId": "pcnY",
        "PhoneNoE": "17000000008"
      }
    ],
    "Limit": 1,
    "Offset": 10,
    "Total": 123
  }
}

错误码

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

状态码	错误码	错误信息
200	SystemError	系统错误
200	IllegalArgument	非法的参数
200	InternalServiceFailed	The internal service error