logo
ConsoleSign Up
Document
Client API
Server API
In-app Chat
Overview
Release Notes
Accessing Server APIs
Call API Online
Connect to ZEGOCLOUD Document MCP Serverlink
User
Room
Group
Message
Call invitation
Conversation
Bot
ZIMAudio
Callbacks
Return codes
Debugging guide of server API operations
Privacy policylink
On this page

ModifyRoomAttribute

POST

https://zim-api.zego.im/

Update custom room attributes based on the room ID. A room can have a maximum of 20 room attributes. If you need to increase the limit, please contact ZEGOCLOUD Technical Support.

After the room attributes are updated, you can receive notifications of room attribute updates through the following ZIM SDK callbacks:

iOSAndroidmacOSWindows
roomAttributesUpdatedonRoomAttributesUpdatedroomAttributesUpdatedonRoomAttributesUpdated
WebMini ProgramFlutterReact Native
roomAttributesUpdatedroomAttributesUpdatedonRoomAttributesUpdatedroomAttributesUpdated
Unity3Duni-app | uni-app xHarmonyOS
OnRoomAttributesUpdatedroomAttributesUpdatedroomAttributesUpdated
QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [ModifyRoomAttribute]

    API prototype parameter

    https://zim-api.zego.im/?Action=ModifyRoomAttribute

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

Body

required
    FromUserId stringrequired

    Possible values: <= 32 characters

    Operator, must be in registered status. This user will not automatically join the room. Only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ' ', ',', '{'

    RoomId stringrequired

    Possible values: <= 32 characters

    Room ID. Only supports numbers, English characters, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', ',', '{'

    Attributes object[]required
    Room attribute information to be updated.
  • Array[
    • Action numberrequired

    Possible values: [0, 1]

    Delete or set.

    • 0: Set;
    • 1: Delete.
    Key stringrequired

    Room attribute key.

    Note

    If the passed Key already exists, the existing attribute information will be modified.

    Value string

    Room attribute value.

    AutoDelete number

    Possible values: [0, 1]

    Whether to automatically delete when the user exits.

    • 0: Do not automatically delete;
    • 1: Automatically delete.
    If FromUserId is not in the room, the deletion operation will be triggered when the user first enters the room and then exits.
    StopOnError integer

    Possible values: [0, 1]

    Whether to enable fast failure, disabled by default.

    • 0: Disable fast failure. When an error is encountered during execution, record the current attribute and continue with subsequent update operations. After execution, return all recorded attributes.
    • 1: Enable fast failure. When an error is encountered during execution, stop the update operation and return the attributes of this update. Successfully executed update operations will be retained.
  • ]

Responses​

OK
Schema
    Code integer

    Return status code (0 indicates success).

    The following only lists the Code and SubCode related to the API business logic. For the complete return codes, please refer to Return codes.

    Code / SubCodeDescriptionSolution
    660000002Parameter error.Please check the parameters.
    660300005Frequency limit.Please try again later.
    Message string

    Return status information.

    RequestId string

    Unique request identifier.

    AttributeSeq int32

    Records the total number of changes to all attributes (create, modify, delete) in the room, used to calibrate attributes and calculate the order of attribute changes. The AttributeSeq value increases by 1 each time an attribute changes.

    Note: When multiple attributes change at once, the AttributeSeq value will increase multiple times. For example, if 3 attributes are modified at once, the AttributeSeq value will increase by 3.

    SuccKeyList object[]
    List of successful keys (returned only on success)
  • Array[
    • Key string

    Successfully modified key.

    Seq int32

    Sequence number of the room attribute Key, used to calibrate attributes and calculate the order of attribute changes. When each attribute is successfully created or modified, the Seq value equals the current AttributeSeq.

  • ]
    • ErrKeyList object[]
    List of error keys (returned only on failure).
  • Array[
    • SubCode number

    Specific return code. For the complete return codes, please refer to the Code description or Return codes.

    Key string

    Key value that encountered an error.

  • ]

Previous

Query room attributes

Next

Destroy a room

On this page

Back to top