tencent cloud

PrevNext

フィードバック

キーワードで検索してください

Recent Pages

ドキュメント
Chat
    ドキュメント
    Download PDF

    Adding Group Members

    最終更新日:2024-07-16 11:15:59
    PDFファイルをダウンロード

      Feature Overview

      This API allows the app administrator to add new members to a group.

      API Calling Description

      Applicable group types

      Group Type
      Support for This RESTful API
      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 Tencent Cloud Chat. For more information, see Group System.
      Note
      Audio-video groups (AVChatRoom) do not support this API. If you use this API on an audio-video group, error 10007 will be returned. The only way for users to join this type of group is to apply to join.

      Sample request URL

      https://xxxxxx/v4/group_open_http_svc/add_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/add_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

      Basic format Used to invite users to a group. A single request supports adding up to 300 members. By default, the backend delivers group system notifications to all group members, except for private groups (or work groups in the new version) that have not been activated.
      {
        "GroupId": "@TGS#2J4SZEAEL", // (Required) Target group
        "MemberList": [ // Up to 300 members can be added at a time.
        {
            "Member_Account": "tommy" // The ID of the member to be added (required)
        },
        {
            "Member_Account": "jared"
        }]
      }
      Adding members silently When Silence is set to 1, the system does not notify anyone after successfully adding members.
      {
        "GroupId": "@TGS#2J4SZEAEL", // (Required) Target group
        "Silence": 1, // Whether to add members silently (optional)
        "MemberList": [ // Up to 300 members can be added at a time.
        {
            "Member_Account": "tommy" // The ID of the member to be added (required)
        },
        {
            "Member_Account": "jared"
        }]
      }

      Request fields

      Field
      Type
      Required
      Description
      GroupId
      String
      Yes
      The ID of the target group
      Silence
      Integer
      Yes
      Whether to add members silently. 0: No. 1: Yes. The default value is 0.
      MemberList
      Array
      Yes
      A list of the members to be added
      Member_Account
      String
      Yes
      The UserID of the member to be added

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "MemberList": [
          {
               "Member_Account": "tommy",
               "Result": 1 // The result of adding the member. 0: failed. 1: successful. 2: already in the group.
          },
          {
               "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
      The UserID of the member
      Result
      Integer
      The result of adding the member. 0: Failed. 1: Successful. 2: Already in the group. 3: Pending approval by the invitee or admin.

      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 number of member accounts in the request packet exceeds 300.
      10007
      No operation permissions. In this case, check whether the group type supports user invitation. For example, AVChatRoom and BChatRoom groups do not allow anyone to invite others to the groups.
      10014
      The users in the request cannot be added to the group because the group is already full. In this case, try deleting some Member_Account in the request or change the value of the MaxMemberNum field in the basic group information. For information, see the Basic group information section in Group basic information.
      10010
      The group does not exist or has been deleted.
      10015
      Invalid group ID. Use a correct group ID.
      10016
      The developer backend has rejected this operation through a webhook.
      10019
      The UserID does not exist. Make sure all the accounts specified in Member_Account are correct.
      10026
      The command word of the SDKAppID request is disabled. Contact customer service.
      10037
      The number of groups that the invited user has joined exceeds the limit. In this case, check and delete the Member_Account that has joined excessive groups, or purchase an upgrade based on the your need. For information about Chat plans, see Pricing.

      API Debugging Tool

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

      References

      Possible Webhooks

      Before Inviting a User to a Group
      After a User Joins a Group
      After a Group Is Full
      お問い合わせ

      カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

      お問い合わせ
      テクニカルサポート

      さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

      チケットを送信
      電話サポート（24 時間365日対応）
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      個人情報保護方針利用規約クッキーポリシー