You need to enable JavaScript to run this app.
导航
启用&停用应用 ModifyAppStatus
最近更新时间:2024.07.16 15:31:23首次发布时间:2024.03.26 14:35:18

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本

在实时音视频场景中,你可以通过调用此接口对应用进行启用或停用操作。

  • 启用:正常使用状态,为新创建 AppID 的默认状态。
  • 停用:变更后的状态,只表示当前 AppID 功能不可用,即 RTC 的基础功能和增值功能都不可用,包括用户无法加入房间、云端媒体处理的功能无法开启等,但不影响控制台正常显示该 AppID 信息。

不论当前 AppID 是启用 or 停用状态,都会显示在控制台上。

注意事项

请求频率:QPS 不得超过 20

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2023-11-01

调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
需要停用/启用的 AppId
Status
Integer
1
  • 1:将 App 状态设置为启用;
  • 2:将 App 状态设置为停用;

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构
其中返回值 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"
}

错误码

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