在你的音视频应用中,当你需要新建业务标识时,你可以使用 AddBusinessID 这一 OpenAPI 实现这一功能。
你可以使用AddBusinessID接口为指定 AppId 新建业务标识。
使用此接口新建业务标识的效果和在控制台上手动创建一致。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | AddBusinessID | 接口名称。当前 API 的名称为 AddBusinessID。 |
| Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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"
}
json{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "AddBusinessID",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": "success"
}
json您可访问公共错误码,获取更多错误码信息。