You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /语音服务/API参考/隐私号/AX & AXB/AX/AXB更新
AX/AXB更新
最近更新时间：2023.08.17 20:56:55首次发布时间：2023.02.28 20:31:37
我的收藏

更新AX/AXB的绑定关系。

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是UpdateAXB接口名称。该接口固定值为UpdateAXB。
VersionString是2022-01-01接口版本。语音服务默认接口版本为2022-01-01。

Body

参数数据类型是否必填示例值描述

UpdateType

String

是

updateExpireTime

修改绑定关系的操作，包括：

  • updateExpireTime：修改过期时间

  • updateUserData：修改userData

  • updateOutId：修改outId

  • updatePhoneNoA：更新A号码

  • updatePhoneNoB：更新B号码

NumberPoolNoString是NP160084061100694433号码池编号
SubIdString是S160817372431596661绑定关系ID

ExpireTime

Long

否

1608209071

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

UserDataString否123213用户拓展参数，最大长度为2048
OutIdString否45354657外部业务id，最大长度128位
PhoneNoAString否13700000000A号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869
PhoneNoBString否13700000001B号码，可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符，例如02131075869。注：AX关系不可直接更新B号码
3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

参数数据类型示例值描述
ResultBooleantrue操作结果

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=UpdateAXB&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=NP167091900000000' \
--data-urlencode 'SubId=S16721313136440a77e10c' \
--data-urlencode 'UpdateType=updateUserData' \
--data-urlencode 'UserData=123'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221227165611852D5262835FA16C6DE1",
        "Action": "UpdateAXB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": true
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221227165843BDDF1A83F5A0F2708FCA",
        "Action": "UpdateAXB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "IllegalArgument",
            "Message": "ExpireTime must be 1 minute later"
        }
    }
}