GetGroup

Last updated: 2019-12-14 11:26:47

PDF

1. API Description

API domain name: cam.tencentcloudapi.com.

This API queries user group details

Default API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: GetGroup
Version Yes String Common parameter; the version of this API: 2019-01-16
Region No String Common parameter; optional for this API.
GroupId Yes Integer User group ID

3. Output Parameters

Parameter name Type Description
GroupId Integer User group ID
GroupName String Name of the user group
GroupNum Integer Number of members in the user group
Remark String Description of the user group
CreateTime String Creation time of the user group
UserInfo Array of GroupMemberInfo Member information of the user group
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Querying User Group Details

Input Sample Code

https://cam.tencentcloudapi.com/?Action=GetGroup
&GroupId=2020
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "GroupId": 2020,
    "GroupName": "test1",
    "GroupNum": 1,
    "Remark": "test2",
    "CreateTime": "2019-04-03 15:11:34",
    "UserInfo": [
      {
        "Uid": 1001408,
        "Uin": 100000545998,
        "Name": "testName",
        "PhoneNum": "",
        "CountryCode": "86",
        "PhoneFlag": 0,
        "Email": "",
        "EmailFlag": 0,
        "UserType": 3,
        "CreateTime": "2018-04-24 15:36:26",
        "IsReceiverOwner": 0
      }
    ],
    "RequestId": "4a00d281-862a-4699-9d71-387d9fc2c36a"
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

This API has no error codes related to business logic. For other error codes, see Common Error Codes.