调用CreateApp创建白板应用。

使用说明

  • 本接口用于创建白板应用。
  • 目前互动白板控制台还未正式上线,请通过互动白板服务端SDK进行白板应用的相关操作。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:CreateApp

RegionId String cn-shanghai

地域ID。

AppName String new_whiteboard_app

创建白板应用时用户在控制台设置的应用名称,由1~32位的中文、英文、数字或下划线组成。

返回数据

名称 类型 示例值 描述
RequestId String 0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92

请求ID。

ResponseSuccess Boolean true

调用结果。

ErrorCode String null

错误码。

ErrorMsg String null

错误信息。

Result Object

返回的结果信息。

AppID String 7mbj****

应用ID。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateAppResponse>
    <RequestId>0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92</RequestId>
    <ResponseSuccess>true</ResponseSuccess>
    <Result>
        <AppID>7mbj****</AppID>
    </Result>
</CreateAppResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0E2ECCA1-5340-43AE-A1DC-EBD17D3CCE92",
  "ResponseSuccess" : true,
  "Result" : {
    "AppID" : "7mbj****"
  }
}