接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:StartView | create | *App acs:rtc::{#accountId}:app/{#AppId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID，通过控制台创建和查询，仅支持传单个 ID。 | eo85**** |
| ChannelId | string | 是 | 已存在的频道 ID，仅支持传单个 ID。 | testid |
| TemplateId | string | 是 | 模版 ID。 | 567 |
| TaskId | string | 是 | 本次任务 ID，仅支持传单个 ID。由大小写字母、数字、下划线、短划线（-）组成，最大 55 字节。 | 123 |
| CropMode | integer | 否 | 裁剪方式。取值：
| 2 |
| StartWithoutChannel | boolean | 否 | 是否允许频道不存在时开启任务。
| |
| StartWithoutChannelWaitTime | integer | 否 | 当 StartWithoutChannel 参数为 true 的时候，设置该值才有意义，表示房间未开启时，任务等待时长，单位为秒，区间限制为[30,120]。 | 30 |
| RegionColor | object | 否 | 全局框格底色 | |
| R | integer | 否 | R。 | 255 |
| G | integer | 否 | G。 | 255 |
| B | integer | 否 | B。 | 255 |
| BgColor | object | 否 | 全局背景色 | |
| R | integer | 否 | R。 | 255 |
| G | integer | 否 | G。 | 255 |
| B | integer | 否 | B。 | 255 |
| ViewSubscribers | array | 否 | 允许看主流或者共享流画面的 SIP 设备的用户 ID 列表。 | |
| string | 否 | 具体用户 ID。 | 12 | |
| ViewContent | string | 否 | 流属性
| main |
返回参数
示例
正常返回示例
JSON格式
{
"TaskId": 123,
"RequestId": "FA2F9DE9-8EAD-580E-87DF-A3D25EE87C37"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-11-05 | 新增 OpenAPI | 查看变更详情 |