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

接口行为

你可以使用AddBusinessID接口为指定 AppId 新建业务标识。

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

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制
请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是AddBusinessID接口名称,本接口取值:AddBusinessID
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdstring是Your_AppId应用的唯一标志
BusinessIdstring是Your_BusinessId业务 ID,同一个 AppId 下不允许重复。长度不超过 64 个字符,取值范围为:数字、字母、_、-、@。
Remarksstring是Your_Remarks业务名称,同一个 AppId 下不允许重复。长度不超过 24 个字符,取值范围为:数字、中文字符、字母和下划线。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=AddBusinessID&Version=2020-12-01
postscript
Body
{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",   
    "Remarks": "Your_Remarks"
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"success",失败时为空。

正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "AddBusinessID",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": "success"
}
json