{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-imp/ban-all-comment":{"post":{"operationId":"cloud_aliyun_imp_ban_all_comment","summary":"Mutes all users in a room by calling the BanAllComment operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is…"},"RoomId":{"type":"string","description":"The unique identifier of the room. The ID is returned when you call the CreateRoom operation"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the mute-all operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/ban-comment":{"post":{"operationId":"cloud_aliyun_imp_ban_comment","summary":"Mutes a specific user in a room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","BanCommentUser"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. This ID is generated when you create the application in the console. The ID contains lowercase letters and digits and…"},"RoomId":{"type":"string","description":"The unique identifier of the room, returned when you call the CreateRoom operation"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the mute operation"},"BanCommentUser":{"type":"string","description":"The user ID of the user to be muted"},"BanCommentTime":{"type":"integer","description":"The mute duration. Unit: seconds. If this parameter is not specified, the default mute duration is 30 seconds. A value of 0 indicates a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/cancel-ban-all-comment":{"post":{"operationId":"cloud_aliyun_imp_cancel_ban_all_comment","summary":"Cancels the mute-all restriction in a room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"RoomId":{"type":"string","description":"The unique identifier of the room, which is returned when you call CreateRoom"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the cancel mute-all operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/cancel-ban-comment":{"post":{"operationId":"cloud_aliyun_imp_cancel_ban_comment","summary":"Cancels the comment ban on a specific user in a room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","BanCommentUser"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"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":{"type":"string","description":"The unique identifier of the room, returned when you call the CreateRoom operation"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the cancel comment ban operation"},"BanCommentUser":{"type":"string","description":"The user ID of the user whose comment ban is to be canceled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/cancel-user-admin":{"post":{"operationId":"cloud_aliyun_imp_cancel_user_admin","summary":"Cancels the administrator role of a specific user in a room, changing the user to a regular viewer","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, consisting of 6 lowercase letters and digits"},"RoomId":{"type":"string","description":"The unique identifier of the room, returned when you call CreateRoom"},"UserId":{"type":"string","description":"The ID of the user whose administrator role is to be canceled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-class":{"post":{"operationId":"cloud_aliyun_imp_create_class","summary":"Creates a class by calling CreateClass. The class can be used for scenarios such as student learning and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Title","CreateUserId","CreateNickname"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"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":{"type":"string","description":"The class title. Chinese and English characters are supported. The maximum length is 32 characters"},"CreateUserId":{"type":"string","description":"The user ID of the creator. Only letters and digits are supported. The maximum length is 36 characters"},"CreateNickname":{"type":"string","description":"The nickname of the creator. Chinese and English characters are supported. The maximum length is 32 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-live":{"post":{"operationId":"cloud_aliyun_imp_create_live","summary":"Creates a live stream with a creation status of not yet started","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"RoomId":{"type":"string","description":"The unique identifier of the room. The value is up to 36 characters in length"},"UserId":{"type":"string","description":"The user who creates the live stream. The value must be unique within the specified AppId. The value can contain lowercase letters,…"},"LiveId":{"type":"string","description":"The unique identifier of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character…"},"Title":{"type":"string","description":"The title of the live stream. The value can contain Chinese and English characters and is up to 256 characters in length"},"Introduction":{"type":"string","description":"The introduction of the live stream. The value can contain Chinese and English characters and is up to 2048 characters in length"},"AnchorId":{"type":"string","description":"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":{"type":"integer","description":"The bitrate of the live stream. Default value: 3. Valid values: -1: smooth (lld). 1: standard definition (lsd). 2: high definition (lhd).…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-live-record-slice-file":{"post":{"operationId":"cloud_aliyun_imp_create_live_record_slice_file","summary":"Creates a live recording slice file by calling CreateLiveRecordSliceFile","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId","StartTime","EndTime","FileName"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which consists of 6 lowercase letters and digits"},"LiveId":{"type":"string","description":"The live stream ID"},"StartTime":{"type":"integer","description":"The start time of the slice. This value is a UNIX timestamp in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the slice. This value is a UNIX timestamp in milliseconds"},"FileName":{"type":"string","description":"The custom file name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-live-room":{"post":{"operationId":"cloud_aliyun_imp_create_live_room","summary":"Invokes CreateLiveRoom to create a live room in the creation status","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Title","AnchorId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits…"},"Title":{"type":"string","description":"The title of the live room. Chinese and English characters are supported. Maximum length: 32 characters"},"Notice":{"type":"string","description":"The announcement of the live room. Chinese and English characters are supported. Maximum length: 256 characters"},"CoverUrl":{"type":"string","description":"The cover image URL of the live room. Maximum length: 256 characters"},"Extension":{"type":"string","description":"The extension field. Pass this parameter as needed to record additional live room properties. Maximum length: 4,096 characters…"},"AnchorId":{"type":"string","description":"The anchor ID. Only letters and digits are supported. Maximum length: 36 characters"},"AnchorNick":{"type":"string","description":"The nickname of the anchor. Chinese and English characters are supported. Maximum length: 32 characters"},"UserId":{"type":"string","description":"The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters"},"EnableLinkMic":{"type":"string","description":"Specifies whether to enable the co-streaming feature. Default value: false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-room":{"post":{"operationId":"cloud_aliyun_imp_create_room","summary":"Creates a room. Users can use features such as live streaming, whiteboard, and audio and video communication…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Title","RoomOwnerId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"TemplateId":{"type":"string","description":"The template ID. Valid values: default: the default template. If you leave this parameter empty, the value default is used"},"RoomId":{"type":"string","description":"The room ID. Maximum length: 36 characters. If you leave this parameter empty, a room ID is randomly generated"},"Title":{"type":"string","description":"The room title. Chinese characters, English characters, and digits are supported. Maximum length: 32 characters"},"Notice":{"type":"string","description":"The room notice. Chinese characters, English characters, digits, and common symbols are supported. Maximum length: 256 characters"},"RoomOwnerId":{"type":"string","description":"The ID of the room owner. Only English characters and digits are supported. Maximum length: 36 characters"},"Extension":{"type":"string","description":"The extension field. Pass this parameter as needed to record additional room properties. The total length of all field key-value pairs…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/create-sensitive-word":{"post":{"operationId":"cloud_aliyun_imp_create_sensitive_word","summary":"Creates custom sensitive words","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","WordList"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID, which is generated when you create the application in the console. The ID contains lowercase letters and digits and is…"},"WordList":{"type":"string","description":"The list of sensitive words. Sensitive words support Chinese characters, letters, and digits. English sensitive words are not supported.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-class":{"post":{"operationId":"cloud_aliyun_imp_delete_class","summary":"Deletes a class by calling DeleteClass","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits…"},"ClassId":{"type":"string","description":"The unique identifier of the class"},"UserId":{"type":"string","description":"The user ID of the operator. The value can contain letters, digits, underscores (_), and hyphens (-) and is 1 to 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-comment":{"post":{"operationId":"cloud_aliyun_imp_delete_comment","summary":"Calls DeleteComment to delete a comment message","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","CommentIdList"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"RoomId":{"type":"string","description":"The unique identifier of the room, returned when you call CreateRoom"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the delete comment message operation"},"CommentIdList":{"type":"string","description":"The list of comment message IDs to delete. The maximum length of the list cannot exceed 100 (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-conference":{"post":{"operationId":"cloud_aliyun_imp_delete_conference","summary":"Ends a co-streaming session by calling DeleteConference. This operation is typically used to end a session…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","ConferenceId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"RoomId":{"type":"string","description":"The room ID. This ID is returned by the room creation operation"},"UserId":{"type":"string","description":"The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length"},"ConferenceId":{"type":"string","description":"The unique ID of the co-streaming resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-live":{"post":{"operationId":"cloud_aliyun_imp_delete_live","summary":"Deletes a live streaming record","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"LiveId":{"type":"string","description":"The unique ID of the live streaming resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-live-files-by-id":{"post":{"operationId":"cloud_aliyun_imp_delete_live_files_by_id","summary":"Calls the DeleteLiveFilesById operation to delete the recording files of a live stream","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"LiveId":{"type":"string","description":"The live stream ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-live-room":{"post":{"operationId":"cloud_aliyun_imp_delete_live_room","summary":"Deletes a live streaming record by calling DeleteLiveRoom","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"LiveId":{"type":"string","description":"The unique ID of the live streaming session"},"UserId":{"type":"string","description":"The ID of the operator. The value can contain only letters and digits and is up to 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-room":{"post":{"operationId":"cloud_aliyun_imp_delete_room","summary":"Deletes a specified room. After the room is deleted, it can no longer be used","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"RoomId":{"type":"string","description":"The room ID. The value can contain letters, digits, underscores (_), and periods (.), with a maximum length of 36 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/delete-sensitive-word":{"post":{"operationId":"cloud_aliyun_imp_delete_sensitive_word","summary":"Deletes sensitive words by calling DeleteSensitiveWord","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and…"},"WordList":{"type":"string","description":"The list of sensitive words to delete. Only sensitive words that have been previously created can be deleted (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/describe-meter-imp-play-back-time-by-live-id":{"post":{"operationId":"cloud_aliyun_imp_describe_meter_imp_play_back_time_by_live_id","summary":"Queries the playback duration of a specified live streaming resource by calling…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId","StartTs","EndTs"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"LiveId":{"type":"string","description":"The unique ID of the live streaming resource. If you leave this parameter empty, the system automatically generates a 36-character random…"},"StartTs":{"type":"integer","description":"The start time of the query. Specify a UNIX timestamp. Unit: seconds"},"EndTs":{"type":"integer","description":"The end time of the query. Specify a UNIX timestamp. Unit: seconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/describe-meter-imp-watch-live-time-by-live-id":{"post":{"operationId":"cloud_aliyun_imp_describe_meter_imp_watch_live_time_by_live_id","summary":"Queries watch duration data by live stream ID, including standard-latency watch duration and low-latency…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"LiveId":{"type":"string","description":"The unique ID of the live stream resource. If you leave this parameter empty, the system automatically generates a 36-character random…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-auth-token":{"post":{"operationId":"cloud_aliyun_imp_get_auth_token","summary":"Retrieves a persistent connection token. The client can use this token to communicate with various atomic…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","AppKey","UserId","DeviceId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits,…"},"AppKey":{"type":"string","description":"The application key, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in length"},"UserId":{"type":"string","description":"The user ID, which is user-defined and must be unique within the scope of an AppId. The value contains lowercase letters, digits,…"},"DeviceId":{"type":"string","description":"The device ID that uniquely identifies a user device. This value is user-defined and contains lowercase letters, digits, underscores (_),…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-class-detail":{"post":{"operationId":"cloud_aliyun_imp_get_class_detail","summary":"Queries the details of a class by calling GetClassDetail. You can use this operation to query the class…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters…"},"ClassId":{"type":"string","description":"The unique identifier of the class, which is returned by the CreateClass operation"},"UserId":{"type":"string","description":"The user ID of the operator. The ID can contain only letters and digits and is up to 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-class-record":{"post":{"operationId":"cloud_aliyun_imp_get_class_record","summary":"Calls GetClassRecord to retrieve class recording information. You can use this operation to obtain the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits…"},"ClassId":{"type":"string","description":"The unique identifier of the class, returned by calling CreateClass"},"UserId":{"type":"string","description":"The user ID of the operator. The value can contain only letters and digits and is up to 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-conference":{"post":{"operationId":"cloud_aliyun_imp_get_conference","summary":"Queries the information about a specified co-streaming session by calling GetConference, including the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConferenceId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"ConferenceId":{"type":"string","description":"The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-live":{"post":{"operationId":"cloud_aliyun_imp_get_live","summary":"Queries information associated with a specified live stream","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"LiveId":{"type":"string","description":"The unique ID of the live stream resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-live-record":{"post":{"operationId":"cloud_aliyun_imp_get_live_record","summary":"Retrieves live recording information. You can call this operation to obtain the playback URL after a live…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which is a 6-character string of lowercase letters and digits. You can obtain this identifier…"},"LiveId":{"type":"string","description":"The unique identifier of the live stream, returned by calling CreateLiveRoom"},"UserId":{"type":"string","description":"The user ID of the operator"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-live-room":{"post":{"operationId":"cloud_aliyun_imp_get_live_room","summary":"Queries the information about a specified live room by calling GetLiveRoom","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters…"},"LiveId":{"type":"string","description":"The unique ID of the live stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-live-room-statistics":{"post":{"operationId":"cloud_aliyun_imp_get_live_room_statistics","summary":"Invokes GetLiveRoomStatistics to query the statistics information of a specified live room. This operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID. This ID is generated when you create an application in the console. It consists of 6 lowercase letters and digits"},"LiveId":{"type":"string","description":"The unique ID of the live room resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-live-room-user-statistics":{"post":{"operationId":"cloud_aliyun_imp_get_live_room_user_statistics","summary":"Invokes GetLiveRoomUserStatistics to query user viewing statistics for a specified live room by paging. This…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, which is generated when the application is created in the console. The ID consists of lowercase letters…"},"LiveId":{"type":"string","description":"The unique ID of the live resource"},"PageNumber":{"type":"string","description":"The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"string","description":"The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-room":{"post":{"operationId":"cloud_aliyun_imp_get_room","summary":"Queries the information about a specified room, including room details and active atomic capability…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"RoomId":{"type":"string","description":"The room ID. The value can contain letters, digits, periods (.), and hyphens (-), with a maximum length of 36 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/get-standard-room-jump-url":{"post":{"operationId":"cloud_aliyun_imp_get_standard_room_jump_url","summary":"Retrieves a redirect URL for the low-code service by calling GetStandardRoomJumpUrl","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","UserId","AppKey","Platform","BizType","BizId","UserNick"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits,…"},"UserId":{"type":"string","description":"The user ID, which is unique within the specified AppId. The value contains lowercase letters, digits, underscores (_), and periods (.).…"},"AppKey":{"type":"string","description":"The terminal device type, created and queried in the console. The value contains lowercase letters and digits, and is 32 characters in…"},"Platform":{"type":"string","description":"The platform type for which to retrieve the URL. Valid values: win: Windows. web: Web. mac: Mac"},"BizType":{"type":"string","description":"The business scenario type. Valid values: live: interactive live streaming. class: interactive classroom"},"BizId":{"type":"string","description":"The resource ID. The value varies by business scenario type: For interactive live streaming, specify the live streaming ID (LiveId). For…"},"UserNick":{"type":"string","description":"The nickname displayed for the user. The value contains uppercase and lowercase letters, Chinese characters, digits, underscores (_),…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/kick-room-user":{"post":{"operationId":"cloud_aliyun_imp_kick_room_user","summary":"Kicks a specific user out of a room by calling the KickRoomUser operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","KickUser"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which consists of 6 lowercase letters and digits"},"RoomId":{"type":"string","description":"The unique identifier of the room, which is returned when you call the CreateRoom operation"},"UserId":{"type":"string","description":"The user ID of the operator, which indicates who performed the kick operation"},"KickUser":{"type":"string","description":"The user ID of the user to be kicked out of the room"},"BlockTime":{"type":"integer","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-classes":{"post":{"operationId":"cloud_aliyun_imp_list_classes","summary":"Invokes ListClasses to retrieve a list of classes. You can perform a paged query of all classes for an…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which consists of 6 lowercase letters and digits"},"Status":{"type":"integer","description":"The class status. 0: not started 1: in progress 2: ended If this parameter is not specified, all classes are returned"},"PageNumber":{"type":"integer","description":"The page number, starting from 1. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-comments":{"post":{"operationId":"cloud_aliyun_imp_list_comments","summary":"Queries comment messages in batches by calling ListComments","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","PageNum","PageSize","SortType"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"RoomId":{"type":"string","description":"The unique ID of the room, which is returned when you call CreateRoom"},"UserId":{"type":"string","description":"The ID of the operator who performs the batch query operation on comment messages"},"CreatorId":{"type":"string","description":"The ID of the comment creator"},"PageNum":{"type":"integer","description":"The page number for querying comment messages in batches. The value starts from 1 and increments by 1 for each subsequent page"},"PageSize":{"type":"integer","description":"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":{"type":"integer","description":"The sort order for querying comment messages in batches. Valid values: 0 and 1. 0: sorts comment messages by creation time in descending…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-conference-users":{"post":{"operationId":"cloud_aliyun_imp_list_conference_users","summary":"Calls ListConferenceUsers to query co-streaming user information by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConferenceId","PageNumber","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"ConferenceId":{"type":"string","description":"The unique identifier of the co-streaming session. The value consists of letters, digits, and hyphens (-), and is 36 characters in length"},"PageNumber":{"type":"integer","description":"The page number, starting from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-live-files":{"post":{"operationId":"cloud_aliyun_imp_list_live_files","summary":"Queries the list of live stream recording files by calling ListLiveFiles","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"LiveId":{"type":"string","description":"The live stream ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-live-rooms":{"post":{"operationId":"cloud_aliyun_imp_list_live_rooms","summary":"Invokes ListLiveRooms to query live room information by using paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and…"},"Status":{"type":"integer","description":"The live streaming status. Valid values: 0: created but not started. 1: streaming. 2: ended. 3 or empty: all statuses"},"PageNumber":{"type":"integer","description":"The page number to query, starting from 1. If left empty, page 1 is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 50. If left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-live-rooms-by-id":{"post":{"operationId":"cloud_aliyun_imp_list_live_rooms_by_id","summary":"Queries the information about specified live rooms in batch by live room ID by calling ListLiveRoomsById","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveIdList"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The value contains lowercase letters and…"},"LiveIdList":{"type":"string","description":"The list of live room IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-room-users":{"post":{"operationId":"cloud_aliyun_imp_list_room_users","summary":"Invokes ListRoomUsers to query the real-time user list in a room by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and…"},"PageNumber":{"type":"integer","description":"The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 100. If this parameter is left empty, the default value is 50"},"RoomId":{"type":"string","description":"The room ID, consisting of letters, digits, underscores (_), and periods (.). Maximum length: 36 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-rooms":{"post":{"operationId":"cloud_aliyun_imp_list_rooms","summary":"Queries the list of rooms under an application, including the information about each room and the atomic…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"PageNumber":{"type":"integer","description":"The page number to query, starting from 1. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 50. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/list-sensitive-word":{"post":{"operationId":"cloud_aliyun_imp_list_sensitive_word","summary":"Queries sensitive words by calling ListSensitiveWord","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, which is generated when you create an application in the console. The value contains lowercase letters and…"},"PageNum":{"type":"integer","description":"The current page number for the paged query. The value starts from 1 and increments by 1 for each subsequent page"},"PageSize":{"type":"integer","description":"The size of each paging query. Default value: 100. If the value exceeds 100, it is set to 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/publish-live":{"post":{"operationId":"cloud_aliyun_imp_publish_live","summary":"Publishes a live stream, changes the live stream status to streaming, and retrieves the push and pull stream…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LiveId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"LiveId":{"type":"string","description":"The unique ID of the live stream resource"},"UserId":{"type":"string","description":"The user ID, which must be unique within the AppId. The ID can contain lowercase letters, digits, underscores (_), and periods (.). The…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/publish-live-room":{"post":{"operationId":"cloud_aliyun_imp_publish_live_room","summary":"Calls the PublishLiveRoom operation to publish a live room, change the live room status to streaming, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. The ID is generated when you create the application in the console. It contains lowercase letters and digits…"},"LiveId":{"type":"string","description":"The unique ID of the live room"},"UserId":{"type":"string","description":"The ID of the operator. Only letters and digits are supported. Maximum length: 36 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/remove-member":{"post":{"operationId":"cloud_aliyun_imp_remove_member","summary":"Removes a specified user from a conference call by calling RemoveMember","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ConferenceId","ToUserId","FromUserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"ConferenceId":{"type":"string","description":"The unique ID of the conference call. The value consists of letters, digits, and hyphens (-), and is 36 characters in length"},"ToUserId":{"type":"string","description":"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":{"type":"string","description":"The ID of the user who initiates the removal. The ID must be unique within the AppId. The value consists of letters, digits, underscores…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/send-comment":{"post":{"operationId":"cloud_aliyun_imp_send_comment","summary":"Sends a comment message by calling SendComment. The comment message is pushed to all online users in the room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","SenderId","Content"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application, which is generated when you create the application in the console. The value contains lowercase letters and…"},"RoomId":{"type":"string","description":"The unique identifier of the room, which is returned when you call CreateRoom"},"SenderId":{"type":"string","description":"The user ID of the comment message sender. The maximum length is 32 bytes"},"SenderNick":{"type":"string","description":"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":{"type":"string","description":"The content of the comment message. The maximum length is 256 bytes"},"Extension":{"type":"string","description":"The extension field in key-value format. The server passes through the extension field information to the client (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/send-custom-message-to-all":{"post":{"operationId":"cloud_aliyun_imp_send_custom_message_to_all","summary":"Calls SendCustomMessageToAll to send a custom message to all online members in a room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","Body"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The user's application ID, generated when creating an application in the console. Contains lowercase letters and digits, with a length of…"},"RoomId":{"type":"string","description":"The unique identifier of the room, returned when calling CreateRoom"},"Body":{"type":"string","description":"The content of the custom message body, with a maximum size of 2048 bytes"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/send-custom-message-to-users":{"post":{"operationId":"cloud_aliyun_imp_send_custom_message_to_users","summary":"Sends a custom message to specified members in a room by calling SendCustomMessageToUsers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","Body","ReceiverList"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application. This ID is generated when you create the application in the console. The ID contains lowercase letters and…"},"RoomId":{"type":"string","description":"The unique identifier of the room, returned when you call CreateRoom"},"Body":{"type":"string","description":"The content of the custom message body. The maximum size is 2048 bytes"},"ReceiverList":{"type":"string","description":"The list of recipient user IDs for the custom message. The maximum length is 100 (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/set-user-admin":{"post":{"operationId":"cloud_aliyun_imp_set_user_admin","summary":"Sets a specific user as an administrator in a room by calling the SetUserAdmin operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which consists of 6 lowercase letters and digits"},"RoomId":{"type":"string","description":"The unique identifier of the room, which is returned when you call the CreateRoom operation"},"UserId":{"type":"string","description":"The ID of the user to be set as an administrator"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/stop-class":{"post":{"operationId":"cloud_aliyun_imp_stop_class","summary":"Stops a class by calling StopClass, which changes the class status to ended","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and…"},"ClassId":{"type":"string","description":"The unique identifier of the class"},"UserId":{"type":"string","description":"The user ID of the operator. Only letters and digits are supported. Maximum length: 36 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/stop-live":{"post":{"operationId":"cloud_aliyun_imp_stop_live","summary":"Stops a specified live stream and changes the live stream status to ended","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId","UserId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits and is 6 characters in length"},"RoomId":{"type":"string","description":"The room ID. The value can contain letters and digits and is up to 36 characters in length"},"UserId":{"type":"string","description":"The user ID of the live stream creator. The value must be unique within the AppId. The value can contain lowercase letters, digits,…"},"LiveId":{"type":"string","description":"The unique ID of the live stream resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/stop-live-room":{"post":{"operationId":"cloud_aliyun_imp_stop_live_room","summary":"Stops a specified live room by calling StopLiveRoom. The live room status changes to ended","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits…"},"LiveId":{"type":"string","description":"The unique ID of the live room"},"UserId":{"type":"string","description":"The operator ID. The value can contain only letters and digits and is up to 36 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/update-class":{"post":{"operationId":"cloud_aliyun_imp_update_class","summary":"Updates a class by calling UpdateClass","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The value contains lowercase letters and digits…"},"ClassId":{"type":"string","description":"The unique identifier of the class"},"Title":{"type":"string","description":"The class title. The value can contain letters and Chinese characters and is up to 32 characters in length"},"CreateUserId":{"type":"string","description":"The user ID of the creator. The value can contain letters and digits and is up to 36 characters in length"},"CreateNickname":{"type":"string","description":"The nickname of the creator. The value can contain letters and Chinese characters and is up to 32 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/update-live":{"post":{"operationId":"cloud_aliyun_imp_update_live","summary":"Updates the information of a specified live broadcast","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"LiveId":{"type":"string","description":"The unique ID of the live broadcast resource"},"Title":{"type":"string","description":"The live broadcast title, which supports both Chinese and English characters with a maximum length of 256 characters"},"Introduction":{"type":"string","description":"The live broadcast introduction, which supports both Chinese and English characters with a maximum length of 2048 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/update-live-room":{"post":{"operationId":"cloud_aliyun_imp_update_live_room","summary":"Updates the information of a specified live room by calling UpdateLiveRoom","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","LiveId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID of the user, generated when the application is created in the console. The ID contains lowercase letters and digits and…"},"Title":{"type":"string","description":"The live room title. Supports Chinese and English characters with a maximum length of 32 characters"},"Notice":{"type":"string","description":"The live room announcement. Supports Chinese and English characters with a maximum length of 256 characters"},"CoverUrl":{"type":"string","description":"The cover image of the live room. Specify the value as an image URL with a maximum length of 256 characters"},"Extension":{"type":"string","description":"The extension field. Pass as needed to record additional room properties (JSON-encoded)"},"AnchorId":{"type":"string","description":"The anchor ID. Supports only letters and digits with a maximum length of 36 characters"},"AnchorNick":{"type":"string","description":"The anchor nickname. Supports Chinese and English characters with a maximum length of 32 characters"},"UserId":{"type":"string","description":"The operator ID. Supports only letters and digits with a maximum length of 36 characters"},"LiveId":{"type":"string","description":"The unique ID of the live room"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/update-room":{"post":{"operationId":"cloud_aliyun_imp_update_room","summary":"Calls UpdateRoom to update all modifiable information of a room","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","RoomId"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application. The value can contain lowercase letters and digits, and must be 6 characters in length"},"RoomId":{"type":"string","description":"The room ID. The value can contain letters, digits, underscores (_), and periods (.). The maximum length is 36 characters"},"Title":{"type":"string","description":"The room title. The value supports both Chinese and English characters, with a maximum length of 32 characters"},"Notice":{"type":"string","description":"The room notice. The value supports both Chinese and English characters, with a maximum length of 256 characters"},"RoomOwnerId":{"type":"string","description":"The ID of the room owner. The value can contain only letters and digits, with a maximum length of 36 characters"},"Extension":{"type":"string","description":"The extension field. Pass this parameter as needed to record additional room properties (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/update-share-screen-layout":{"post":{"operationId":"cloud_aliyun_imp_update_share_screen_layout","summary":"Updates the shared screen layout by calling UpdateShareScreenLayout. This operation can be used in classroom…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","ClassId","EnableOverlay"],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"},"AppId":{"type":"string","description":"The unique identifier of the application, which consists of 6 lowercase letters and digits"},"ClassId":{"type":"string","description":"The unique identifier of the classroom, returned by calling CreateClass"},"EnableOverlay":{"type":"string","description":"Specifies whether to enable the teacher's camera overlay"},"OverlayX":{"type":"number","description":"The X coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1"},"OverlayY":{"type":"number","description":"The Y coordinate of the overlay. The origin is the upper-left corner. The value is normalized to 1"},"OverlayWidth":{"type":"number","description":"The width of the overlay, normalized to 1"},"OverlayHeight":{"type":"number","description":"The height of the overlay, normalized to 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-imp/version":{"post":{"operationId":"cloud_aliyun_imp_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://imp.aliyuncs.com"],"default":"https://imp.aliyuncs.com","description":"Regional endpoint, for example https://imp.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}