logo
In-app Chat
ZIMAudio
On this page

QueryGroupsInfoOfUser

POST

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

Query the group information that a user has joined.

QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [QueryGroupsInfoOfUser]

    API prototype parameter

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

    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

    User ID to query.

    Limit numberrequired

    Possible values: >= 1 and <= 100

    Number of groups returned per page. Value range is [1, 100].

    Next string

    Pagination identifier. Fill in an empty string for the first request to get the first page, and fill in the NextRsp value in the response result for subsequent requests to get the next page.

Responses

OK
Schema
    Code integer

    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 CodeDescriptionSolution
    660000002Parameter error.Please check the parameters.
    660300005Frequency limit.Please try again later.
    660500002The operator user is not registered.Please register the requested user first.
    Message string

    Return status information.

    RequestId string

    Unique request identifier.

    NextRsp string

    Pagination identifier for the next page. If it is 0, it means no more data.

    HasJoinGroupNum int64

    Number of groups the user has joined.

    GroupInfoList object[]
    Group information list that the user has joined.
  • Array[
  • GroupId string

    Group ID.

    GroupName string

    Group name.

    GroupAvatar string

    Group avatar.

  • ]

Previous

Query user information

Next

Register users

On this page

Back to top