You need to enable JavaScript to run this app.
导航

查询绑定关系

最近更新时间2023.08.17 20:58:23

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

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

1. 接口说明
  • 请求方式:POST

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


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

Authorization

String

HMAC-SHA256 Credential***

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

ServiceNameStringvms服务名称。语音服务的服务名称是vms
RegionStringcn-north-1区域名称,固定值cn-north-1

Content-Type

String

application/x-www-form-urlencoded

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

Query

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

Body

参数数据类型是否必填示例值描述
NumberPoolNoStringNP160084061100694433X号码所在的号码池编号
SubIdStringS160817372431596661绑定关系ID

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

ResponseMetadata

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

Result

参数数据类型示例值描述

SubId

String

S160817372431596661

绑定关系ID

PhoneNoAString17000000000A号码
PhoneNoBString17000000001B号码
PhoneNoXString17000000002X号码
PhoneNoYString17000000009Y号码

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错误信息。

4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=QuerySubscription&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 'NumberPoolNo=NP1670919495020000' \
--data-urlencode 'SubId=S167213187000000'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122717224907C768C42C2A3B6B2DD5",
        "Action": "QuerySubscription",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "SubId": "S1672131870644092fd87e",
        "PhoneNoA": "18800000000",
        "PhoneNoB": "",
        "PhoneNoX": "18800000001",
        "PhoneNoY": "",
        "Status": 0,
        "RecordFlag": 1,
        "EnableTime": 1672131871,
        "ExpireTime": 1672216113,
        "CallDisplayType": 1,
        "CallDisplayTypeName": "不透传",
        "UserData": "",
        "OutId": "",
        "PhoneNoE": ""
    }
}