tencent cloud

Feedback

Changing Group Owner

Last updated: 2023-03-10 14:50:04

    Feature Overview

    • The app admin can call this API to transfer the group ownership to others.
    • For a group without an owner, the app admin can call this API to specify a user as the owner of the group.
    • The new group owner must be a member of the group.

    API Calling Description

    Applicable group types

    Group Type ID RESTful API Support
    Private Yes. Same as work groups (Work) in the new version.
    Public Yes
    ChatRoom Yes. Same as the meeting group (Meeting) in the new version.
    AVChatRoom No (See the note below)
    Community Yes

    These are the preset group types in Chat. For more information, see Group System.

    Note:

    Audio-video groups (AVChatRoom) do not support the transfer of group ownership. If you call this API for such a group, error code 10007 will be returned.

    Sample request URL

    https://xxxxxx/v4/group_open_http_svc/change_group_owner?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
    

    Request parameters

    The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.

    Parameter Description
    xxxxxx Domain name corresponding to the country/region where your SDKAppID is located.
  • China: console.tim.qq.com
  • Singapore: adminapisgp.im.qcloud.com
  • Seoul: adminapikr.im.qcloud.com
  • Frankfurt: adminapiger.im.qcloud.com
  • Mumbai: adminapiind.im.qcloud.com
  • Silicon Valley: adminapiusa.im.qcloud.com
  • v4/group_open_http_svc/change_group_owner Request API
    sdkappid SDKAppID assigned by the Chat console when an app is created
    identifier App admin account. For more information, see the App Admin section in Login Authentication.
    usersig Signature generated by the app admin account. For details, see Generating UserSig.
    random A random 32-bit unsigned integer ranging from 0 to 4294967295.
    contenttype Request format. The value is fixed to json.

    Maximum call frequency

    200 calls per second

    Sample request

    Transfer the group ownership to another group member. The new group owner must be a member of the group.

    {
        "GroupId": "@TGS#1NVTZEAE4",  // (Required) ID of the group whose ownership is to be transferred
        "NewOwner_Account": "peter" // (Required) ID of the new group owner
    }
    

    Request fields

    Field Type Required Description
    GroupId String Yes ID of the group whose ownership is to be transferred
    NewOwner_Account String Yes ID of the new group owner

    Sample response

    {
        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode":0
    }
    

    Response fields

    Field Type Description
    ActionStatus String Request result. OK: successful; FAIL: failed
    ErrorCode Integer Error code. 0: Successful; other values: Failed
    ErrorInfo String Error information

    Error Codes

    The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
    For public error codes (60000 to 79999), see Error Codes.
    The following table describes the error codes specific to this API:

    Error Code Description
    10002 A system error occurred. Try again or contact technical support.
    10004 A parameter is invalid. Check the ErrorInfo field in the response packet to see whether the required fields have been specified or whether the fields are set according to protocol requirements.
    10007 Insufficient operation permissions. Check whether the operator is the app admin.
    10010 The group does not exist or has been deleted.
    10015 Invalid group ID. Check whether the group ID is entered correctly.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Recalling group messages (v4/group_open_http_svc/group_msg_recall)

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support