如果你已创建应用,你可以控制该应用的启用/停用状态。你可以使用 ModifyAppStatus 这个 OpenAPI 实现这一功能。

接口行为

你可以调用 ModifyAppStatus 这个 OpenAPI 修改 AppId 对应 App 的状态,状态分为启用和停用两种。

1. 当前 AppID 功能不可用:指 RTC 的基础功能和增值功能都不可用,包括用户无法加入房间、后处理的功能无法开启等。

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

调用接口
使用限制

QPS 不得超过 20。

请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是ModifyAppStatus接口名称
VersionString是2020-12-01OpenAPI 版本
Body
参数名类型必填示例值描述
AppIdString是Your_AppId需要停用/启用的 AppId
StatusInt是1
  • 1:将 App 状态设置为启用;
  • 2:将 App 状态设置为停用;
  • 请求示例代码
    Query
    https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2020-12-01
    
    postscript
    Body
    {
        "AppId": "Your_AppId",
        "Status": "Your_AppStatus"
    }
    
    json
    返回调用结果

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

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