调用SetAppStatus为白板应用设置状态。

说明 目前互动白板控制台还未正式上线,请通过互动白板服务端SDK进行白板应用的相关操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetAppStatus

系统规定参数。取值:SetAppStatus

AppID String 7mbjnzq8

白板应用唯一标识符。更多信息,请参见CreateApp

AppStatus Long 1

白板应用状态。取值:

  • 1:启用。
  • 2:停用。

返回数据

名称 类型 示例值 描述
ErrorCode String null

错误码。

ErrorMsg String null

错误信息。

RequestId String FE22D613-D3C6-4A58-87CA-F21FC85AA08E

请求ID。

ResponseSuccess Boolean true

请求结果。

Result Boolean true

返回的结果信息。

示例

请求示例

http(s)://rtc-white-board.cn-shanghai.aliyuncs.com/?Action=SetAppStatus
&<公共请求参数>

正常返回示例

XML格式

<SetAppStatusResponse>
  <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
  <ResponseSuccess>true</ResponseSuccess>
  <Result>true</Result>
</SetAppStatusResponse>

JSON格式

{
"RequestId":"FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
"ResponseSuccess":true,
"Result":true
}