GetGroup

Download PDF

Last updated: 2021-07-08 16:09:29

Download PDF

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API is used to query user group details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: GetGroup.
Version	Yes	String	Common parameter. The value used for this API: 2019-01-16.
Region	No	String	Common parameter. This parameter is not required for this API.
GroupId	Yes	Integer	User Group ID

3. Output Parameters

Parameter Name	Type	Description
GroupId	Integer	User Group ID
GroupName	String	User Group name
GroupNum	Integer	Number of members in the User Group
Remark	String	User Group description
CreateTime	String	Time User Group created
UserInfo	Array of GroupMemberInfo	User Group member information
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying user group details

Input Example

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

Output Example

{
  "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

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
ResourceNotFound.UserNotExist	User does not exist.

Recent Pages

GetGroup

1. API Description

2. Input Parameters

3. Output Parameters