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

FetchForbidGroupList

POST

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

This API is used to query the IDs of all muted groups in the App, including groups in all-member mute, group role mute, or user ID mute status.

This API returns 10,000 groups by default each time. If you need to adjust this limit, please contact ZEGOCLOUD Technical Support.

QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [FetchForbidGroupList]

    API prototype parameter

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

    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 of the query operator (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).

    StartFlag numberrequired

    Pagination flag.

    • Fill in 0 for the first time;
    • Then fill in the NextFlag value returned last time.
    When the returned NextFlag is 0, it means the group list has been fully retrieved.

Responses​

OK
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 codeDescriptionSuggested Solution
    660000002Input parameter error.Please check the input parameters.
    660000003Logic processing error.Please retry or contact ZEGOCLOUD Technical Support.
    660000011Number of users exceeds the limit.Please check the input user list.
    Message string

    Description of the operation result.

    RequestId string

    Request ID.

    FetchEnd number

    [object Object]

    NextFlag number
    • When FetchEnd is 0, it means there are still more groups to retrieve. You can use this as the StartFlag for the next API call.
    • When FetchEnd is 1, it means the list has been fully retrieved. Please ignore this field at this time.
    GroupList object[]
    List of muted groups.
  • Array[
    • GroupId string

    Group ID.

    ForbidType number

    Mute type:

    • 1: All-member mute
    • 2: Group role mute
    • 4: User ID mute

    If multiple mute situations exist simultaneously, ForbidType will add these values together. For example, when both all-member mute (1) and group role mute (2) exist, ForbidType is 3.

  • ]

Previous

Mute group members

Next

Disband a group conversation

On this page

Back to top