本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。
在实时音视频场景中,你可以通过调用此接口对应用进行启用或停用操作。
不论当前 AppID 是启用 or 停用状态,都会显示在控制台上。
rtc.volcengineapi.com
。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyAppStatus | 接口名称。当前 API 的名称为 ModifyAppStatus 。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AppId | String | 是 | 661e****543cf | 需要停用/启用的 AppId |
Status | Integer | 是 | 1 |
|
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result
仅在请求成功时返回 success
,失败时为空。
POST https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2023-11-01 { "AppId": "661e****543cf", "Status": "1" }
{ "ResponseMetadata": { "RequestId": "202108171748410****524310002120A9F", "Action": "ModifyAppStatus", "Version": "2023-11-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": "success" }
您可访问公共错误码,获取更多错误码信息。