logo
In-app Chat
ZIMAudio
On this page

TransferGroupOwner

GET

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

By calling this API, you can transfer the group owner identity to other members in the group.

After successful transfer, group members will receive relevant notifications through the following ZIM SDK callback interfaces:

iOSAndroidmacOSWindows
groupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdatedonGroupMemberInfoUpdated
WebMini ProgramFlutterReact Native
groupMemberInfoUpdatedgroupMemberInfoUpdatedonGroupMemberInfoUpdatedgroupMemberInfoUpdated
Unity3Duni-app | uni-app xHarmonyOS
OnGroupMemberInfoUpdatedgroupMemberInfoUpdatedgroupMemberInfoUpdated
Note

The parameters FromUserId, GroupId, and NewOwner only support numbers, English characters, and '!','#','$','%','&','(',')','+','\'',':',';','<','=','.','>','?' ,'@','[',']','^','_','{','}','|','~'.

QPS Limit
1 time/s, group-level limit. If you need to adjust this limit, please contact ZEGOCLOUD Technical Support.

Request

Query Parameters

    Action stringrequired

    Possible values: [TransferGroupOwner]

    API prototype parameter

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

    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.

    FromUserId stringrequired

    Possible values: <= 32 characters

    Operator user ID (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.

    NewOwner stringrequired

    Possible values: <= 32 characters

    New group owner (user receiving the transfer) ID, must be a user in the group.

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
    660000002Parameter error.Please check the request parameters.
    660300006Call frequency limit exceeded.Please try again later.
    660500002Operator user is not registered.Please register the user first.
    660600001Group does not exist.Please check if the GroupID is correct.
    660600024User receiving the transfer is not in the group.Please add the user to the group.
    Message string

    Description of the operation result.

    RequestId string

    Request ID.

Previous

Remove group members

Next

Add group members

On this page

Back to top