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

添加业务标识 AddBusinessID

最近更新时间2024.02.29 19:30:24

首次发布时间2022.09.20 15:07:37

在你的音视频应用中,当你需要新建业务标识时,你可以使用 AddBusinessID 这一 OpenAPI 实现这一功能。

使用说明

接口行为

你可以使用AddBusinessID接口为指定 AppId 新建业务标识。
使用此接口新建业务标识的效果和在控制台上手动创建一致。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
Your_AppId
应用的唯一标志
BusinessId
String
Your_BusinessId
业务 ID,同一个 AppId 下不允许重复。长度不超过 64 个字符,取值范围为:数字、字母、_-@
Remarks
String
Your_Remarks
业务名称,同一个 AppId 下不允许重复。长度不超过 24 个字符,取值范围为:数字、中文字符、字母和下划线。

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=AddBusinessID&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",   
    "Remarks": "Your_Remarks"
}

返回示例

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

错误码

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