tencent cloud

Feedback

Importing Group Members

Last updated: 2024-07-16 11:15:59

    Feature Overview

    This API is used to import group members without triggering callbacks or delivering notifications.
    When your app needs to be migrated to Chat from another instant messaging system, you can use this API to import existing group member data.

    API Calling Description

    Applicable group types

    Group Type
    Applicable
    Private
    Yes. Same as work groups (Work) in the new version.
    Public
    Yes
    ChatRoom
    Yes. Same as meeting groups (Meeting) in the new version.
    AVChatRoom
    No
    Community
    Yes
    Above are the built-in group types of the Chat service. For more information, see Group System.
    Note
    Generally, importing group members is not required for audio-video groups (AVChatRoom), so audio-video groups do not support this API. If you attempt to use this API on an audio-video group, error 10007 will be returned.

    Sample request URL

    https://xxxxxx/v4/group_open_http_svc/import_group_member?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
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/group_open_http_svc/import_group_member
    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

    You can call this API to initiate a request to import members to a group. A single request can import up to 300 members. If the unread message count specified by this API is greater than the current number of messages of the group, the unread message count is set to the current number of messages of the group.
    Caution
    Before importing a member, ensure that the time that the member joined the group is later than the group creation time and earlier than the current time. Otherwise, the member cannot be imported.
    {
    "GroupId": "@TGS#2J4SZEAEL", // (Required) Target group
    "MemberList": [ // Up to 300 members can be added at a time.
    {
    "Member_Account": "tommy", // (Required) ID of the member to be added
    "Role":"Admin", // (Optional) Role of the group member to be imported. Currently, the only supported role is Admin.
    "JoinTime":1448357837, // (Optional) Time when the group member to be imported joined the group
    "UnreadMsgNum":5 // (Optional) Unread message count of the member
    
    },
    {
    "Member_Account": "jared",
    "JoinTime":1448357857,
    "UnreadMsgNum":2
    }]
    }

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Yes
    ID of the target group
    MemberList
    Array
    Yes
    A list of the members to be added
    Member_Account
    String
    Yes
    Group member accounts to be imported
    Role
    String
    No
    Role of the group member to be imported. Currently, only Admin is supported. If this field is not specified, the value Member (ordinary user) is used.
    JoinTime
    Integer
    No
    Time when the group member to be imported joined the group
    UnreadMsgNum
    Integer
    No
    Unread message count of the group member to be imported

    Sample response

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MemberList": [
    {
    "Member_Account": "tommy",
    "Result": 1 // Result of the import. 0: Failed; 1: Succeeded; 2: Already a group member
    },
    {
    "Member_Account": "jared",
    "Result": 1
    }]
    }

    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
    MemberList
    Array
    The result of adding members
    Member_Account
    String
    Account of the group member
    Result
    Integer
    Result of the import. 0: Failed; 1: Succeeded; 2: Already a group member

    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
    Internal server error. Try again.
    10003
    Invalid command word.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10005
    The request packet carries too many accounts.
    10006
    Reached the operation frequency limit. Please reduce the call rate.
    10007
    No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so.
    10010
    The group does not exist or has been disbanded.
    10015
    Invalid group ID. Use the correct group ID.

    API Debugging Tool

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

    References

    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