# Alibaba Cloud Interactive Media Platform API

> Alibaba Cloud Interactive Media Platform API on Apizie: 58 endpoints (Mutes all users in a room by calling the BanAllComment operation, Mutes a specific user in a room, Cancels the mute-all restriction in a room, Cancels the comment ban on a specific user in a room, …) 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://www.apizie.tech/v1/cloud:aliyun-imp/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-imp`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/imp
- Page: https://www.apizie.tech/api/cloud/aliyun-imp
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-imp/openapi.json

Alibaba Cloud OpenAPI for Interactive Media Platform (imp, version 2021-06-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Mutes all users in a room by calling the BanAllComment operation
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/ban-all-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is… |
| RoomId | string | yes | The unique identifier of the room. The ID is returned when you call the CreateRoom operation |
| UserId | string | yes | The user ID of the operator, which indicates who performed the mute-all operation |

### Mutes a specific user in a room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/ban-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID. This ID is generated when you create the application in the console. The ID contains lowercase letters and digits and… |
| RoomId | string | yes | The unique identifier of the room, returned when you call the CreateRoom operation |
| UserId | string | yes | The user ID of the operator, which indicates who performed the mute operation |
| BanCommentUser | string | yes | The user ID of the user to be muted |
| BanCommentTime | integer | no | The mute duration. Unit: seconds. If this parameter is not specified, the default mute duration is 30 seconds. A value of 0 indicates a… |

### Cancels the mute-all restriction in a room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/cancel-ban-all-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| RoomId | string | yes | The unique identifier of the room, which is returned when you call CreateRoom |
| UserId | string | yes | The user ID of the operator, which indicates who performed the cancel mute-all operation |

### Cancels the comment ban on a specific user in a room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/cancel-ban-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID. This ID is generated when you create the application in the console. It contains lowercase letters and digits and is 6… |
| RoomId | string | yes | The unique identifier of the room, returned when you call the CreateRoom operation |
| UserId | string | yes | The user ID of the operator, which indicates who performed the cancel comment ban operation |
| BanCommentUser | string | yes | The user ID of the user whose comment ban is to be canceled |

### Cancels the administrator role of a specific user in a room, changing the user to a regular viewer
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/cancel-user-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, consisting of 6 lowercase letters and digits |
| RoomId | string | yes | The unique identifier of the room, returned when you call CreateRoom |
| UserId | string | yes | The ID of the user whose administrator role is to be canceled |

### Creates a class by calling CreateClass. The class can be used for scenarios such as student learning and…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when you create an application in the console. The ID consists of lowercase letters and… |
| Title | string | yes | The class title. Chinese and English characters are supported. The maximum length is 32 characters |
| CreateUserId | string | yes | The user ID of the creator. Only letters and digits are supported. The maximum length is 36 characters |
| CreateNickname | string | yes | The nickname of the creator. Chinese and English characters are supported. The maximum length is 32 characters |

### Creates a live stream with a creation status of not yet started
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| RoomId | string | yes | The unique identifier of the room. The value is up to 36 characters in length |
| UserId | string | yes | The user who creates the live stream. The value must be unique within the specified AppId. The value can contain lowercase letters,… |
| LiveId | string | no | The unique identifier of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character… |
| Title | string | no | The title of the live stream. The value can contain Chinese and English characters and is up to 256 characters in length |
| Introduction | string | no | The introduction of the live stream. The value can contain Chinese and English characters and is up to 2048 characters in length |
| AnchorId | string | no | The anchor ID. The value can contain Chinese and English characters and is up to 128 characters in length. If you leave this parameter… |
| CodeLevel | integer | no | The bitrate of the live stream. Default value: 3. Valid values: -1: smooth (lld). 1: standard definition (lsd). 2: high definition (lhd).… |

### Creates a live recording slice file by calling CreateLiveRecordSliceFile
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-live-record-slice-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which consists of 6 lowercase letters and digits |
| LiveId | string | yes | The live stream ID |
| StartTime | integer | yes | The start time of the slice. This value is a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the slice. This value is a UNIX timestamp in milliseconds |
| FileName | string | yes | The custom file name |

### Invokes CreateLiveRoom to create a live room in the creation status
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits… |
| Title | string | yes | The title of the live room. Chinese and English characters are supported. Maximum length: 32 characters |
| Notice | string | no | The announcement of the live room. Chinese and English characters are supported. Maximum length: 256 characters |
| CoverUrl | string | no | The cover image URL of the live room. Maximum length: 256 characters |
| Extension | string | no | The extension field. Pass this parameter as needed to record additional live room properties. Maximum length: 4,096 characters… |
| AnchorId | string | yes | The anchor ID. Only letters and digits are supported. Maximum length: 36 characters |
| AnchorNick | string | no | The nickname of the anchor. Chinese and English characters are supported. Maximum length: 32 characters |
| UserId | string | no | The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters |
| EnableLinkMic | string | no | Specifies whether to enable the co-streaming feature. Default value: false |

### Creates a room. Users can use features such as live streaming, whiteboard, and audio and video communication…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| TemplateId | string | no | The template ID. Valid values: default: the default template. If you leave this parameter empty, the value default is used |
| RoomId | string | no | The room ID. Maximum length: 36 characters. If you leave this parameter empty, a room ID is randomly generated |
| Title | string | yes | The room title. Chinese characters, English characters, and digits are supported. Maximum length: 32 characters |
| Notice | string | no | The room notice. Chinese characters, English characters, digits, and common symbols are supported. Maximum length: 256 characters |
| RoomOwnerId | string | yes | The ID of the room owner. Only English characters and digits are supported. Maximum length: 36 characters |
| Extension | string | no | The extension field. Pass this parameter as needed to record additional room properties. The total length of all field key-value pairs… |

### Creates custom sensitive words
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/create-sensitive-word` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is… |
| WordList | string | yes | The list of sensitive words. Sensitive words support Chinese characters, letters, and digits. English sensitive words are not supported.… |

### Deletes a class by calling DeleteClass
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits… |
| ClassId | string | yes | The unique identifier of the class |
| UserId | string | no | The user ID of the operator. The value can contain letters, digits, underscores (_), and hyphens (-) and is 1 to 36 characters in length |

### Calls DeleteComment to delete a comment message
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| RoomId | string | yes | The unique identifier of the room, returned when you call CreateRoom |
| UserId | string | yes | The user ID of the operator, which indicates who performed the delete comment message operation |
| CommentIdList | string | yes | The list of comment message IDs to delete. The maximum length of the list cannot exceed 100 (JSON-encoded) |

### Ends a co-streaming session by calling DeleteConference. This operation is typically used to end a session…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| RoomId | string | yes | The room ID. This ID is returned by the room creation operation |
| UserId | string | yes | The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length |
| ConferenceId | string | yes | The unique ID of the co-streaming resource |

### Deletes a live streaming record
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| LiveId | string | yes | The unique ID of the live streaming resource |

### Calls the DeleteLiveFilesById operation to delete the recording files of a live stream
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-live-files-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID |
| LiveId | string | yes | The live stream ID |

### Deletes a live streaming record by calling DeleteLiveRoom
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| LiveId | string | yes | The unique ID of the live streaming session |
| UserId | string | no | The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length |

### Deletes a specified room. After the room is deleted, it can no longer be used
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| RoomId | string | yes | The room ID. The value can contain letters, digits, underscores (_), and periods (.), with a maximum length of 36 characters |

### Deletes sensitive words by calling DeleteSensitiveWord
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/delete-sensitive-word` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and… |
| WordList | string | no | The list of sensitive words to delete. Only sensitive words that have been previously created can be deleted (JSON-encoded) |

### Queries the playback duration of a specified live streaming resource by calling…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/describe-meter-imp-play-back-time-by-live-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| LiveId | string | yes | The unique ID of the live streaming resource. If you leave this parameter empty, the system automatically generates a 36-character random… |
| StartTs | integer | yes | The start time of the query. Specify a UNIX timestamp. Unit: seconds |
| EndTs | integer | yes | The end time of the query. Specify a UNIX timestamp. Unit: seconds |

### Queries watch duration data by live stream ID, including standard-latency watch duration and low-latency…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/describe-meter-imp-watch-live-time-by-live-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| LiveId | string | yes | The unique ID of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character random… |

### Retrieves a persistent connection token. The client can use this token to communicate with various atomic…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits,… |
| AppKey | string | yes | The application key, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in length |
| UserId | string | yes | The user ID, which is user-defined and must be unique within the scope of an AppId. The value contains lowercase letters, digits,… |
| DeviceId | string | yes | The device ID that uniquely identifies a user device. This value is user-defined and contains lowercase letters, digits, underscores (_),… |

### Queries the details of a class by calling GetClassDetail. You can use this operation to query the class…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-class-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters… |
| ClassId | string | yes | The unique identifier of the class, which is returned by the CreateClass operation |
| UserId | string | no | The user ID of the operator. The ID can contain only letters and digits and is up to 36 characters in length |

### Calls GetClassRecord to retrieve class recording information. You can use this operation to obtain the…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-class-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits… |
| ClassId | string | yes | The unique identifier of the class, returned by calling CreateClass |
| UserId | string | no | The user ID of the operator. The value can contain only letters and digits and is up to 36 characters in length |

### Queries the information about a specified co-streaming session by calling GetConference, including the…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| ConferenceId | string | yes | The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length |

### Queries information associated with a specified live stream
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| LiveId | string | yes | The unique ID of the live stream resource |

### Retrieves live recording information. You can call this operation to obtain the playback URL after a live…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-live-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which is a 6-character string of lowercase letters and digits. You can obtain this identifier… |
| LiveId | string | yes | The unique identifier of the live stream, returned by calling CreateLiveRoom |
| UserId | string | no | The user ID of the operator |

### Queries the information about a specified live room by calling GetLiveRoom
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters… |
| LiveId | string | yes | The unique ID of the live stream |

### Invokes GetLiveRoomStatistics to query the statistics information of a specified live room. This operation…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-live-room-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID. This ID is generated when you create an application in the console. It consists of 6 lowercase letters and digits |
| LiveId | string | yes | The unique ID of the live room resource |

### Invokes GetLiveRoomUserStatistics to query user viewing statistics for a specified live room by paging. This…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-live-room-user-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters… |
| LiveId | string | yes | The unique ID of the live resource |
| PageNumber | string | no | The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default |
| PageSize | string | no | The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10 |

### Queries the information about a specified room, including room details and active atomic capability…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| RoomId | string | yes | The room ID. The value can contain letters, digits, periods (.), and hyphens (-), with a maximum length of 36 characters |

### Retrieves a redirect URL for the low-code service by calling GetStandardRoomJumpUrl
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/get-standard-room-jump-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits,… |
| UserId | string | yes | The user ID, which is unique within the specified AppId. The value contains lowercase letters, digits, underscores (_), and periods (.).… |
| AppKey | string | yes | The terminal device type, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in… |
| Platform | string | yes | The platform type for which to retrieve the URL. Valid values: win: Windows. web: Web. mac: Mac |
| BizType | string | yes | The business scenario type. Valid values: live: interactive live streaming. class: interactive classroom |
| BizId | string | yes | The resource ID. The value varies by business scenario type: For interactive live streaming, specify the live streaming ID (LiveId). For… |
| UserNick | string | yes | The nickname displayed for the user. The value contains uppercase and lowercase letters, Chinese characters, digits, underscores (_),… |

### Kicks a specific user out of a room by calling the KickRoomUser operation
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/kick-room-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which consists of 6 lowercase letters and digits |
| RoomId | string | yes | The unique identifier of the room, which is returned when you call the CreateRoom operation |
| UserId | string | yes | The user ID of the operator, which indicates who performed the kick operation |
| KickUser | string | yes | The user ID of the user to be kicked out of the room |
| BlockTime | integer | no | The duration for which the user is kicked out of the room. The user cannot re-enter the room within this period. Unit: seconds. If this… |

### Invokes ListClasses to retrieve a list of classes. You can perform a paged query of all classes for an…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-classes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which consists of 6 lowercase letters and digits |
| Status | integer | no | The class status. 0: not started 1: in progress 2: ended If this parameter is not specified, all classes are returned |
| PageNumber | integer | no | The page number, starting from 1. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10 |

### Queries comment messages in batches by calling ListComments
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| RoomId | string | yes | The unique ID of the room, which is returned when you call CreateRoom |
| UserId | string | no | The ID of the operator who performs the batch query operation on comment messages |
| CreatorId | string | no | The ID of the comment creator |
| PageNum | integer | yes | The page number for querying comment messages in batches. The value starts from 1 and increments by 1 for each subsequent page |
| PageSize | integer | yes | The page size for querying comment messages in batches. The minimum value is 1 and the maximum value is 100. If the value exceeds 100,… |
| SortType | integer | yes | The sort order for querying comment messages in batches. Valid values: 0 and 1. 0: sorts comment messages by creation time in descending… |

### Calls ListConferenceUsers to query co-streaming user information by paging
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-conference-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| ConferenceId | string | yes | The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length |
| PageNumber | integer | yes | The page number, starting from page 1 |
| PageSize | integer | yes | The number of entries per page. Maximum value: 100 |

### Queries the list of live stream recording files by calling ListLiveFiles
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-live-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID |
| LiveId | string | yes | The live stream ID |

### Invokes ListLiveRooms to query live room information by using paging
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-live-rooms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and… |
| Status | integer | no | The live streaming status. Valid values: 0: created but not started. 1: streaming. 2: ended. 3 or empty: all statuses |
| PageNumber | integer | no | The page number to query, starting from 1. If left empty, page 1 is queried by default |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. If left empty, the default value is 10 |

### Queries the information about specified live rooms in batch by live room ID by calling ListLiveRoomsById
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-live-rooms-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and… |
| LiveIdList | string | yes | The list of live room IDs (JSON-encoded) |

### Invokes ListRoomUsers to query the real-time user list in a room by paging
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-room-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and… |
| PageNumber | integer | no | The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. Maximum value: 100. If this parameter is left empty, the default value is 50 |
| RoomId | string | yes | The room ID, consisting of letters, digits, underscores (_), and periods (.). Maximum length: 36 characters |

### Queries the list of rooms under an application, including the information about each room and the atomic…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-rooms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| PageNumber | integer | no | The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10 |

### Queries sensitive words by calling ListSensitiveWord
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/list-sensitive-word` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and… |
| PageNum | integer | no | The current page number for the paged query. The value starts from 1 and increments by 1 for each subsequent page |
| PageSize | integer | no | The size of each paging query. Default value: 100. If the value exceeds 100, it is set to 100 |

### Publishes a live stream, changes the live stream status to streaming, and retrieves the push and pull stream…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/publish-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| LiveId | string | yes | The unique ID of the live stream resource |
| UserId | string | yes | The user ID, which must be unique within the AppId. The ID can contain lowercase letters, digits, underscores (_), and periods (.). The… |

### Calls the PublishLiveRoom operation to publish a live room, change the live room status to streaming, and…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/publish-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. The ID is generated when you create the application in the console. It contains lowercase letters and digits… |
| LiveId | string | yes | The unique ID of the live room |
| UserId | string | no | The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters |

### Removes a specified user from a conference call by calling RemoveMember
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/remove-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| ConferenceId | string | yes | The unique ID of the conference call. The value consists of letters, digits, and hyphens (-), and is 36 characters in length |
| ToUserId | string | yes | The ID of the user to be removed. The ID must be unique within the AppId. The value consists of letters, digits, underscores (_), hyphens… |
| FromUserId | string | yes | The ID of the user who initiates the removal. The ID must be unique within the AppId. The value consists of letters, digits, underscores… |

### Sends a comment message by calling SendComment. The comment message is pushed to all online users in the room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/send-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application, which is generated when you create the application in the console. The value contains lowercase letters and… |
| RoomId | string | yes | The unique identifier of the room, which is returned when you call CreateRoom |
| SenderId | string | yes | The user ID of the comment message sender. The maximum length is 32 bytes |
| SenderNick | string | no | The nickname of the comment message sender. The maximum length is 128 bytes. If this parameter is left empty, the nickname that the sender… |
| Content | string | yes | The content of the comment message. The maximum length is 256 bytes |
| Extension | string | no | The extension field in key-value format. The server passes through the extension field information to the client (JSON-encoded) |

### Calls SendCustomMessageToAll to send a custom message to all online members in a room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/send-custom-message-to-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The user's application ID, generated when creating an application in the console. Contains lowercase letters and digits, with a length of… |
| RoomId | string | yes | The unique identifier of the room, returned when calling CreateRoom |
| Body | string | yes | The content of the custom message body, with a maximum size of 2048 bytes |

### Sends a custom message to specified members in a room by calling SendCustomMessageToUsers
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/send-custom-message-to-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The ID of the application. This ID is generated when you create the application in the console. The ID contains lowercase letters and… |
| RoomId | string | yes | The unique identifier of the room, returned when you call CreateRoom |
| Body | string | yes | The content of the custom message body. The maximum size is 2048 bytes |
| ReceiverList | string | yes | The list of recipient user IDs for the custom message. The maximum length is 100 (JSON-encoded) |

### Sets a specific user as an administrator in a room by calling the SetUserAdmin operation
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/set-user-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which consists of 6 lowercase letters and digits |
| RoomId | string | yes | The unique identifier of the room, which is returned when you call the CreateRoom operation |
| UserId | string | yes | The ID of the user to be set as an administrator |

### Stops a class by calling StopClass, which changes the class status to ended
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/stop-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and… |
| ClassId | string | yes | The unique identifier of the class |
| UserId | string | no | The user ID of the operator. Only letters and digits are supported. Maximum length: 36 characters |

### Stops a specified live stream and changes the live stream status to ended
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/stop-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length |
| RoomId | string | yes | The room ID. The value can contain letters and digits and is up to 36 characters in length |
| UserId | string | yes | The user ID of the live stream creator. The value must be unique within the AppId. The value can contain lowercase letters, digits,… |
| LiveId | string | yes | The unique ID of the live stream resource |

### Stops a specified live room by calling StopLiveRoom. The live room status changes to ended
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/stop-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits… |
| LiveId | string | yes | The unique ID of the live room |
| UserId | string | no | The operator ID. The value can contain only letters and digits and is up to 36 characters in length |

### Updates a class by calling UpdateClass
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/update-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits… |
| ClassId | string | yes | The unique identifier of the class |
| Title | string | no | The class title. The value can contain letters and Chinese characters and is up to 32 characters in length |
| CreateUserId | string | no | The user ID of the creator. The value can contain letters and digits and is up to 36 characters in length |
| CreateNickname | string | no | The nickname of the creator. The value can contain letters and Chinese characters and is up to 32 characters in length |

### Updates the information of a specified live broadcast
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/update-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| LiveId | string | yes | The unique ID of the live broadcast resource |
| Title | string | no | The live broadcast title, which supports both Chinese and English characters with a maximum length of 256 characters |
| Introduction | string | no | The live broadcast introduction, which supports both Chinese and English characters with a maximum length of 2048 characters |

### Updates the information of a specified live room by calling UpdateLiveRoom
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/update-live-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and… |
| Title | string | no | The live room title. Supports Chinese and English characters with a maximum length of 32 characters |
| Notice | string | no | The live room announcement. Supports Chinese and English characters with a maximum length of 256 characters |
| CoverUrl | string | no | The cover image of the live room. Specify the value as an image URL with a maximum length of 256 characters |
| Extension | string | no | The extension field. Pass as needed to record additional room properties (JSON-encoded) |
| AnchorId | string | no | The anchor ID. Supports only letters and digits with a maximum length of 36 characters |
| AnchorNick | string | no | The anchor nickname. Supports Chinese and English characters with a maximum length of 32 characters |
| UserId | string | no | The operator ID. Supports only letters and digits with a maximum length of 36 characters |
| LiveId | string | yes | The unique ID of the live room |

### Calls UpdateRoom to update all modifiable information of a room
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/update-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application. The value can contain lowercase letters and digits, and must be 6 characters in length |
| RoomId | string | yes | The room ID. The value can contain letters, digits, underscores (_), and periods (.). The maximum length is 36 characters |
| Title | string | no | The room title. The value supports both Chinese and English characters, with a maximum length of 32 characters |
| Notice | string | no | The room notice. The value supports both Chinese and English characters, with a maximum length of 256 characters |
| RoomOwnerId | string | no | The ID of the room owner. The value can contain only letters and digits, with a maximum length of 36 characters |
| Extension | string | no | The extension field. Pass this parameter as needed to record additional room properties (JSON-encoded) |

### Updates the shared screen layout by calling UpdateShareScreenLayout. This operation can be used in classroom…
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/update-share-screen-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |
| AppId | string | yes | The unique identifier of the application, which consists of 6 lowercase letters and digits |
| ClassId | string | yes | The unique identifier of the classroom, returned by calling CreateClass |
| EnableOverlay | string | yes | Specifies whether to enable the teacher's camera overlay |
| OverlayX | number | no | The X coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1 |
| OverlayY | number | no | The Y coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1 |
| OverlayWidth | number | no | The width of the overlay, normalized to 1 |
| OverlayHeight | number | no | The height of the overlay, normalized to 1 |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-imp/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://imp.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-imp/ban-all-comment" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Interactive Media Platform API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-imp/ban-all-comment with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Interactive Media Platform 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 Media Platform itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Interactive Media Platform API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-imp.

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