You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

查询绑定关系列表

最近更新时间：2023.08.17 20:58:34

首次发布时间：2023.02.28 20:31:37

我的收藏

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

1. 接口说明

  • 请求方式：POST

  • 接口地址：https://cloud-vms.volcengineapi.com

2. 请求参数
参数数据类型是否必填示例值描述
X-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎。

ServiceNameString是vms服务名称。隐私号服务的服务名称是vms。
RegionString是cn-north-1区域名称，固定值cn-north-1。

Content-Type

String

是

application/x-www-form-urlencoded

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/x-www-form-urlencoded。

Query

参数数据类型是否必填示例值描述
ActionString是QuerySubscriptionForList接口名称。该接口固定值为QuerySubscriptionForList。
VersionString是2022-01-01接口版本。语音服务默认接口版本为2022-01-01。

Body

参数数据类型是否必填示例值描述
NumberPoolNoString否NP160084061100694433号码池编号
SubIdString否S160817372431596661绑定关系ID

PhoneNoA

String

否

13700000001

A号码，可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符，例如02131075869

PhoneNoBString否13700000002B号码，可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符，例如02131075869
PhoneNoXString否13700000000X号码
PhoneNoYString否13700000003Y号码

Status

Integer

否

1

绑定关系状态，0 已解绑；1 已绑定；2 绑定异常

OutIdString否45354657外部业务id，最大长度128位
OffsetLong否0分页偏移量，默认0
LimitInteger否20分页页面条数，默认20

注：[SubId、PhoneNoA、PhoneNoB、PhoneNoX、OutId] 至少需要传一个。

2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数数据类型示例值描述
SubIdStringS160817372431596661绑定关系ID
ParentSubIdStringS160817372431596660父级绑定关系ID
PhoneNoAString17000000000A号码
PhoneNoBString17000000001B号码
PhoneNoXString17000000002X号码
PhoneNoYString17000000002Y号码

Status

Integer

1

绑定关系状态
0 已解绑，1 已绑定，2 绑定异常

RecordFlag

Integer

1

是否需要录音
0：关闭，1 : 开启（默认开启）

EnableTimeLong1608196519生效时间
ExpireTimeLong1608209071过期时间（以秒为单位的时间戳，必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00）

CallDisplayType

Integer

1

是否透传 1：不透传，2：A看见B的真实号码，3：B看见A的真实号码，4：看见对方真实号码

CallDisplayTypeNameString不透传透传类型描述：不透传，A看见B的真实号码，B看见A的真实号码，看见对方真实号码
UserDataString用户拓展参数，最大长度为2048
OutIdString外部业务id，最大长度128位
PhoneNoEString17000000008E号码

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。

3. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=QuerySubscriptionForList&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-urlencode 'PhoneNoX=15510000000' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=5'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221227173107095F2E34EF6E646D37ED",
        "Action": "QuerySubscriptionForList",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "Records": [
            {
                "SubId": "S16721319876440c205139",
                "PhoneNoA": "18000000000",
                "PhoneNoB": "18000000001",
                "PhoneNoX": "18000000002",
                "PhoneNoY": "",
                "Status": 1,
                "RecordFlag": 1,
                "EnableTime": 1672131987,
                "ExpireTime": 1672216113,
                "CallDisplayType": 1,
                "CallDisplayTypeName": "不透传",
                "UserData": "123",
                "OutId": "",
                "PhoneNoE": "9999"
            }
        ],
        "Limit": 20,
        "Offset": 0,
        "Total": 1
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "202212271734000D4AC89EDDCB1C6C66FE",
        "Action": "QuerySubscriptionForList",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "IllegalArgument",
            "Message": "[phoneNoA, phoneNoB, phoneNoX, subId, outId] at least one is required"
        }
    }
}