# Alibaba Cloud Interactive Whiteboard API

> Alibaba Cloud Interactive Whiteboard API on Apizie: 18 endpoints (Creates a whiteboard application. You can set the application name and obtain the AppID at the same time, Creates a whiteboard document and retrieves the document identifier (DocKey), Queries whiteboard application information under a cloud account by using paged query. Paging is supported, Queries the recording list and operation sequences of a whiteboard by paging, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-rtc-white-board`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/rtc-white-board
- Page: https://zieapi.vercel.app/api/cloud/aliyun-rtc-white-board
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-rtc-white-board/openapi.json

Alibaba Cloud OpenAPI for Interactive Whiteboard (rtc-white-board, version 2020-12-14). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a whiteboard application. You can set the application name and obtain the AppID at the same time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppName | string | yes | The application name that you set in the console when creating a whiteboard application. The name must be 1 to 32 characters in length and… |

### Creates a whiteboard document and retrieves the document identifier (DocKey)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/create-white-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | yes | The user ID (business user) who creates the whiteboard. The value is 1 to 32 characters in length and can contain uppercase and lowercase… |
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |

### Queries whiteboard application information under a cloud account by using paged query. Paging is supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/describe-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | no | The unique identifier of the whiteboard application. If this parameter is left empty, all application IDs are queried by default. To… |
| AppStatus | integer | no | The status of the whiteboard application. If this parameter is left empty, all statuses are queried by default. Valid values: 1: Enabled.… |
| PageNum | integer | no | The page number. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. If this parameter is left empty, the default value is 10 |

### Queries the recording list and operation sequences of a whiteboard by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/describe-white-board-recordings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| PageNum | integer | no | The page number. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. If this parameter is left empty, the default value is 10 |

### Queries whiteboard document information under a specified AppID by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/describe-white-boards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| DocStatus | integer | no | The status of the whiteboard document. If this parameter is left empty, all statuses are queried by default. Valid values: 1: Enabled. 2:… |
| PageNum | integer | no | The page number. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. If this parameter is left empty, the default value is 10 |

### Opens an existing whiteboard document and retrieves the connection information for the whiteboard document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/open-white-board` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| UserId | string | yes | The ID of the user who opens the whiteboard (business user), consisting of 1 to 32 characters including uppercase and lowercase letters,… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |

### Pauses the recording of whiteboard operation sequences
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/pause-white-board-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| UserId | string | yes | The ID of the user (business user) who pauses the whiteboard recording. The value consists of 1 to 32 characters including uppercase and… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| RecordId | string | yes | The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html |

### Refreshes the permission cache of whiteboard document users. When a user accesses the whiteboard again, the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/refresh-users-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserIds | string | yes | The IDs of users whose permissions you want to refresh, separated by commas (,). You can specify up to 30 IDs. Each ID consists of digits… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |

### Resumes whiteboard operation sequence recording from a paused state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/resume-white-board-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| UserId | string | yes | The ID of the user (business user) who resumes whiteboard recording. The ID is 1 to 32 characters in length and can contain letters,… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| RecordId | string | yes | The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html |

### Sets the callback type for a whiteboard application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-app-callback-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| AppCallbackType | string | yes | The callback type of the whiteboard application. Separate multiple values with commas (,). Valid values: userPermissionCallback: User… |

### Sets the callback URL and callback authentication code for a whiteboard application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-app-callback-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see… |
| AppCallbackUrl | string | yes | The callback URL of the whiteboard application |
| AppCallbackAuthKey | string | yes | The callback authentication code of the whiteboard application, consisting of 8 to 20 characters including uppercase letters, lowercase… |

### Sets the list of authorized domain names for a whiteboard application, which are the domain names that need…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-app-domain-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see… |
| AppDomainNames | string | yes | The domain names of all customer websites that use the whiteboard application. Separate multiple domain names with commas (,). You can… |

### Renames a whiteboard application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-app-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see… |
| AppName | string | yes | The name of the whiteboard application. The name must be 1 to 32 characters in length and can contain Chinese characters, letters, digits,… |

### Sets the status of a whiteboard application. Valid values: 1 (enabled) and 2 (disabled)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-app-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see… |
| AppStatus | integer | yes | The status of the whiteboard application. Valid values: 1: Enabled. 2: Disabled |

### Sets long-term permissions for users of a whiteboard document
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/set-users-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserIds | string | yes | The IDs of the users for whom you want to set permissions. Separate multiple IDs with commas (,). You can specify up to 30 IDs. Each ID… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| PermissionType | string | yes | The user whiteboard permission type. Valid values: ban: No permissions. read: Read-only. edit: Read and write |

### Starts recording the operation sequence of a whiteboard
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/start-white-board-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| UserId | string | yes | The ID of the user (business user) who starts the whiteboard recording. The value is 1 to 32 characters in length and can contain… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |

### Stops recording a whiteboard operation sequence
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/stop-white-board-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppID | string | yes | The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html |
| UserId | string | yes | The ID of the user (business user) who stops the whiteboard recording. The value is 1 to 32 characters in length and can contain uppercase… |
| DocKey | string | yes | The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html |
| RecordId | string | yes | The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/create-app" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Interactive Whiteboard API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-rtc-white-board/create-app with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Interactive Whiteboard API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Interactive Whiteboard itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Interactive Whiteboard API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-rtc-white-board.

### What is the status of the Alibaba Cloud Interactive Whiteboard API?
Needs your own provider key (bring your own key)