05/15/2024 15:19:45

Group

For detailed description of the union group process and the permission application process, please refer to Group Module.

I. The union binds groups (QQ)

The union president creates and binds QQ groups directly (permissions are required to use this function).

1.1 Interface name

/v2/group/create_bind_group

1.2 Request parameters

1.3 Return parameters

1.4 Request example

• Request

   {
        "openid":"D08BF5F51A67414795F602000B000000",
        "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
        "guild_id":"2134",
        "guild_name":"testitop",
        "zone_id":"1",
        "roleid":"2"
    }
  

• Returned package

    {
        "ret":0,
        "msg":"",
        "groupid":"735088906",
        "group_name":"testitop"
    }
  

II. Query group relationship (QQ or WeChat)

After the union has been bound to a group, this interface can be invoked to query information about the relationship between the user and the group. It can return such information (group owner, administrator, common member, and non-member) (you need to apply for permission when using it).

2.1 Interface name

/v2/group/get_group_rela_info

2.2 Request parameters

Warning: Don't confuse groupid and guild_id; the former is QQ group ID, and the latter is the Union ID in the game.

2.3 Return parameters

2.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "groupid":"735088906"
   }
  

• Returned package

   {
       "ret":0,
       "msg":"",
       "relation":1
   }
  

III. Join an existing group (QQ)

This interface is used for in-game union members to join a QQ group; before invoking this interface, invoke /v2/group/get_group_info interface to query whether the user is a group member; if the user is not a group member, the "Join Group" button (new) will be displayed (the user needs to apply for permission when using it).

3.1 Interface name

/v2/group/join_group

3.2 Request parameters

Warning: Don't confuse groupid and guild_id; the former is QQ group ID, and the latter is the Union ID in the game.

3.3 Return parameters

3.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "guild_id":"2134",
       "groupid":"706990493",
       "zone_id":"1"
   }
  

• Returned package

    {
        "ret":0,
        "msg":""
    }
  

IV. Unbind groups (QQ or WeChat)

If the user voluntarily dissolves the trade union QQ group, the trade union and the trade union QQ group will not be automatically unbound.
PS: There are two ways for a group to cancel its binding relationship with the union:

1. The union president invokes the unbinding interface to dissolve the relationship
   When a union member invokes the group joining interface, if he or she cannot query the group ID at this time, then he or she is thought to unbind the relationship by default
   If a QQ group is disbanded without any of the above operations, the binding relationship will not disappear automatically
   
2. After the union president resigns, the new president can also unbind the relationship.
   

4.1 Interface name

/v2/group/unbind_group

4.2 Request parameters

channel_info field
QQ:

WeChat:

4.3 Return parameters

4.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "channel_info":{
           "guild_id":"2135",
           "guild_name":"itopv2",
           "zone_id":"1"
       }
   }
  

• Returned package

   {
       "ret":0,
       "msg":""
   }
  

V. Launch a QQ group list (QQ)

This interface is used to launch the created group list when the union president binds the union to the QQ groups created by him.

5.1 Interface name

/v2/group/get_group_list

5.2 Request parameters

5.3 Return parameters

In group_list, each data contains a list of fields

5.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A"
   }
  

• Returned package

    {
        "ret":0,
        "msg":"",
        "group_list":[{
                "groupid":"735088906",
                "group_name":"testitop"
        }]
    }
  

VI. Bind the created QQ groups (QQ)

This interface is used for the union president to bind the union to the QQ groups he has created; before invoking this interface, invoke /v2/group/get_group_list interface to launch the created group list.

6.1 Interface name

/v2/group/bind_existing_group

6.2 Request parameters

Warning: Don't confuse groupid and guild_id; the former is QQ group ID, and the latter is the Union ID in the game.

6.3 Return parameters

6.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "guild_id":"2134",
       "groupid":"735088906",
       "group_name":"testitop",
       "zone_id":"1"
   }
  

• Returned package

   {
       "ret":0,
       "msg":""
   }
  

VII. Remind the president to bind groups (QQ)

This interface is used for union members to remind the union president to bind a group when the union is not bound to the group; let the union bind the QQ group I have created, so that I can receive notifications through the Official Account "QQ Mobile Games" but is limited to receive only one notification per day; it is needed to verify that the reminder and the reminded one must be union members, and the game side ensures that the reminded one is the union president.

7.1 Interface name

/v2/group/remind_leader_bind

7.2 Request parameters

7.3 Return parameters

7.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "guild_id":"2135",
       "roleid":"2",
       "leader_openid":"D08BF5F51A67414795F602000B000000",
       "leader_roleid":"2",
       "zone_id":"1"
   }
  

• Returned package

   {
       "ret":0,
       "msg":""
   }
  

VIII. Launch group information (QQ or WeChat)

8.1 Interface name

/v2/group/get_group_info

8.2 Request parameters

channel_info
QQ:

WeChat:

8.3 Return parameters

channel_info
QQ:

WeChat:

8.4 Request example

• Request

   {
       "openid":"D08BF5F51A67414795F602000B000000",
       "token":"6A27E8C2B4EB505BB6D4A230BDDEF00A",
       "channel_info":{
           "guild_id":"2135",
           "zone_id":"1"
       }
   }
  

• Returned package

   {
       "ret":0,
       "msg":"",
       "channel_info":'{
           "groupid":"737550331",
           "group_name":"itopv2",
           "group_key":"hLG0YFQgoCIpQ-6_wo4yPXize0JbkzNu",
           "group_openid":"E571324A65B103B992714A6720DB4EBB"
       }
   }
  

XI. Send group messages (WeChat)

9.1 Interface name

/v2/group/send_group_msg

9.2 Request parameters

open field list

9.3 Return parameters

X. Send group messages (QQ)

Games which invoke this interface need to apply for permission in QQ and configure the callback address. If a game does not apply for permission, invoking the interface will return {"is_lost":0,"msg":"invalid appid","ret":-2}.

10.1 Interface name

/v2/group/send_group_msg

10.2 Request parameters

10.3 Return parameters

10.4 Request example

• Request

   curl -X POST -H 'Content-Type: application/json' 'https://dev.itop.qq.com/v2/group/nnelid=2&gameid=12&os=1&seq=&source=0&ts=1557836202&version=2.0&sig=0fcb1dc59df246cc957224cfe337380f' -d '{"openid":"15879468368890148661","token":"935C4F643BC40AC88095429B1F063E07","pf":"qqqun","group_openid":"EE12810F82CE90426B23F2DCA8301738","title":"msdk test qq send group message","desc":"msdk test qq send group message","redirect_url":"http://docs.itop.qq.com","image_url":"https://avatars0.githubusercontent.com/u/3755338?s=460&v=4","param":"11"}'
  

• Returned package

   {
       "ret":0,
       "msg":""
   }