ModifyGroupAttribute

POST

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

By calling this API, you can set the group attributes of a group.

QPS Limit

20 times/s

Request

Query Parameters

Action stringrequired

Possible values: [ModifyGroupAttribute]

API prototype parameter

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

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.

application/json

Body

required

Action numberrequired

Modification behavior for this request.

0 (default): Update group attributes.
1: Delete group attributes.

FromUserId stringrequired

Operator ID, must be in registered status.

GroupId stringrequired

Group ID.

Attributes object[]required

Updated group attribute information.

Array[

Key stringrequired

Group attribute key. When modifying group attributes, if the group attribute key already exists, the group attribute will be updated; if the group attribute key does not exist, the group attribute will be created.

Value string

Group attribute value. This parameter is required when Action is 0; it is not required when Action is 1.

]

Responses

application/json

Schema
Example (from schema)
Example

Schema

Code number

Return status code (0 indicates success).

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

Return code	Description	Suggested Solution
660000002	Parameter error.	Please check and enter the correct parameters.
660300006	The API call frequency exceeds the group/room limit.	Please try again later.
660500002	FromUserId is not registered.	Please register FromUserId first.
660600001	Group does not exist.	Please confirm if the input GroupId is correct, or create a group.
660600009	Failed to obtain group-related information.	Please confirm if the GroupID is correct first. If the GroupID is correct, please contact ZEGOCLOUD Technical Support.
660600028	Failed to modify group data.	Please contact ZEGOCLOUD Technical Support.
660300019	The total length of the value of the set group attributes exceeds the limit.	Please contact ZEGOCLOUD Technical Support.

Message string

Return status information.

RequestId string

Unique request identifier.

FailKeys object[]

List of keys that failed to update or delete.

Array[

Reason string

Reason for failure.

Key string

Key value that failed to update or delete.

]

Attributes object

List of group attributes that were successfully updated or deleted.

Attributes object[]

Array[

Key string

Group attribute key.

Value string

Group attribute value.

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    },
    {
      "Reason": "key db-non-existent",
      "Key": "attr2"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      },
      {
        "Key": "attribute2",
        "Value": "value2"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "FailKeys": [
    {
      "Reason": "key db-non-existent",
      "Key": "attr1"
    },
    {
      "Reason": "key db-non-existent",
      "Key": "attr2"
    }
  ],
  "Attributes": {
    "Attributes": [
      {
        "Key": "attribute1",
        "Value": "value1"
      },
      {
        "Key": "attribute2",
        "Value": "value2"
      }
    ]
  }
}

ModifyGroupAttribute

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

Request

Query Parameters

Body

Responses​

Responses