QueryGroupInfo

POST

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

By calling this API, you can query group information, including group name, group notice, group avatar, group mute information, group specification limits, group creation time, and group attributes.

QPS Limit

20 times/s

Request

Query Parameters

Action stringrequired

Possible values: [QueryGroupInfo]

API prototype parameter

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

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

FromUserId stringrequired

Possible values: <= 32 characters

User ID of the querier (who has logged in to the ZIM service by calling the login method on the client, or has completed registration by calling the server-side API).

GroupId stringrequired

Possible values: <= 32 characters

Group ID of the query target.

Responses

application/json

Schema
Example (from schema)
Example

Schema

Code number

Return code.

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	Solution
660000002	Input parameter error.	Please check the input parameters.
660300005	The API call frequency exceeds the AppID-level limit.	Please try again later.
660500002	Operator user is not registered.	Please have the operator register with the ZIM service first.

Message string

Description of the operation result.

RequestId string

Request ID.

GroupName string

Group name.

GroupNotice string

Group notice.

GroupDataSeq number

Number of times the group information has been modified.

GroupAvatar string

Group avatar URL.

IsAllForbid boolean

Whether all members are muted.

true: Yes.
false: No.

Note

IsAllForbid and ForbidList will not exist at the same time.

ForbidList number[]

Muted group roles.

1: Group owner.
2: Group administrator.
3: Group member.
Other values: Your custom group roles, generally recommended to be greater than 100.

LimitInfo object

Group specification limits.

MemberCountLimit number

Group member count limit.

JoinMode number

Join mode:

0: No verification required, anyone can join the group directly.
1: Users need to initiate a join request, and can only join the group after approval by the group owner or group administrator.
2: External users can only join the group through invitation by group members.

InviteMode number

Invite mode:

0: All group members can invite external users to join the group.
1: Only the group owner or group administrator can initiate invitations.

BeInvitedMode number

Be invited mode:

0: External users can be directly invited to join the group without their consent.
1: After inviting someone to join the group, their consent is required.

NumberMessage number

Number of historical messages that new members can retrieve after joining the group.

ForbidExpireTime number

Unix timestamp when the mute ends, in milliseconds (ms).

GroupCreateTime number

Unix timestamp when the group was created, in milliseconds (ms).

GroupId string

Group ID.

GroupAttributes object[]

List of group attributes.

Array[

Key string

Key of the group attribute.

Value string

Value of the group attribute.

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "GroupName": "GroupName",
  "GroupNotice": "GroupNotice",
  "GroupDataSeq": 1,
  "GroupAvatar": "https://xxx.com/xxx.png",
  "IsAllForbid": true,
  "ForbidList": [
    2,
    3
  ],
  "LimitInfo": {
    "MemberCountLimit": 100,
    "JoinMode": 1,
    "InviteMode": 1,
    "BeInvitedMode": 1,
    "NumberMessage": 100
  },
  "ForbidExpireTime": 1000,
  "GroupCreateTime": 10000,
  "GroupId": "GroupId",
  "GroupAttributes": [
    {
      "Key": "1",
      "Value": "1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "GroupName": "GroupName",
  "GroupNotice": "GroupNotice",
  "GroupDataSeq": 1,
  "GroupAvatar": "https://xxx.com/xxx.png",
  "IsAllForbid": true,
  "ForbidList": [
    2,
    3
  ],
  "LimitInfo": {
    "MemberCountLimit": 100,
    "JoinMode": 1,
    "InviteMode": 1,
    "BeInvitedMode": 1,
    "NumberMessage": 100
  },
  "ForbidExpireTime": 1000,
  "GroupCreateTime": 10000,
  "GroupId": "GroupId",
  "GroupAttributes": [
    {
      "Key": "1",
      "Value": "1"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "GroupName": "GroupName",
  "GroupNotice": "GroupNotice",
  "GroupDataSeq": 1,
  "GroupAvatar": "https://xxx.com/xxx.png",
  "IsAllForbid": true,
  "ForbidList": [
    2,
    3
  ],
  "LimitInfo": {
    "MemberCountLimit": 100,
    "JoinMode": 1,
    "InviteMode": 1,
    "BeInvitedMode": 1,
    "NumberMessage": 100
  },
  "ForbidExpireTime": 1000,
  "GroupCreateTime": 10000,
  "GroupId": "GroupId",
  "GroupAttributes": [
    {
      "Key": "1",
      "Value": "1"
    },
    {
      "Key": "2",
      "Value": "2"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "GroupName": "GroupName",
  "GroupNotice": "GroupNotice",
  "GroupDataSeq": 1,
  "GroupAvatar": "https://xxx.com/xxx.png",
  "IsAllForbid": true,
  "ForbidList": [
    2,
    3
  ],
  "LimitInfo": {
    "MemberCountLimit": 100,
    "JoinMode": 1,
    "InviteMode": 1,
    "BeInvitedMode": 1,
    "NumberMessage": 100
  },
  "ForbidExpireTime": 1000,
  "GroupCreateTime": 10000,
  "GroupId": "GroupId",
  "GroupAttributes": [
    {
      "Key": "1",
      "Value": "1"
    },
    {
      "Key": "2",
      "Value": "2"
    }
  ]
}