添加业务标识 AddBusinessID--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

添加业务标识 AddBusinessID

最近更新时间：2024.10.14 17:25:23首次发布时间：2022.09.20 15:07:37

在音视频应用中，你可以通过调用此接口特定应用创建新的业务标识。

使用此接口新建业务标识的效果和在控制台上手动创建一致。

注意事项

请求频率：QPS 不超过 20。
BusinessID：单个 AppID 下最多可以创建 1000 个 BusinessID。

该接口请求接入地址仅支持 rtc.volcengineapi.com。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=AddBusinessID&Version=2020-12-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AddBusinessID`	接口名称。当前 API 的名称为 `AddBusinessID`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
BusinessId	String	是	`B****23`	业务 ID，同一个 AppId 下不允许重复。长度不超过 64 个字符，取值范围为：数字、字母、`_`、`-`、`@`。
Remarks	String	是	`新业务`	业务名称，同一个 AppId 下不允许重复。长度不超过 24 个字符，取值范围为：数字、中文字符、字母和下划线。

返回参数

本接口无特有的返回参数，公共返回参数请参见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=AddBusinessID&Version=2020-12-01
{
    "AppId": "661e****543cf",
    "BusinessId": "B****23",
    "Remarks": "测试业务"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "AddBusinessID",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。