All Products
Search
Document Center

ApsaraVideo Live:BanLiveMessageGroup

Last Updated:Nov 14, 2024

Mutes a group.

Operation description

Before you call this operation, make sure that you have called the CreateLiveMessageGroup operation to create an interactive messaging group.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID.

demo
GroupIdstringYes

The group ID.

grouptest
ExceptUsersarrayNo

The users whom you do not want to mute when the group is muted.

stringNo

The ID of the user whom you do not want to mute when the group is muted. Separate multiple user IDs with commas (,).

Note You can specify up to 30 users IDs.
["uid3"]
DataCenterstringNo

The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application.

Note Valid values: cn-shanghai and ap-southeast-1 (Singapore).
cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

84AF36BF-0B39-1F8A-A416-FAC7C484****

Examples

Sample success responses

JSONformat

{
  "RequestId": "84AF36BF-0B39-1F8A-A416-FAC7C484****"
}

Error codes

HTTP status codeError codeError messageDescription
400InputInvalid%s.Illegal input parameters
403NoAuth%s.No permission
404ResourceNotExist%s.The requested resource does not exist, please check and try again
500ServerError%s.Unknown error, please try again later or submit a ticket for consultation.

For a list of error codes, visit the Service error codes.