Adding Members to a Permission Group
Feature Overview
App admins can call this API to add new members to a specified permission group.
API Calling Description
Applicable Group Types
Group Type | Whether This RESTful API Is Supported |
Private | Not supported, same as Work (Work Friend Group) in the new version |
Public | Not supported |
ChatRoom | Not supported, same as Meeting (Temporary Meeting Group) in the new version |
AVChatRoom | Not supported |
Community | Supported |
Sample Request URL
https://xxxxxx/v4/group_open_http_svc/add_permission_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The table below only lists the parameters modified when calling this API and their descriptions. For details on the parameters, refer to RESTful API Overview.
Parameter | Description |
xxxxxx | The dedicated domain name for 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_permission_group_member | Request API |
sdkappid | SDKAppID assigned by the Chat console when an application is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format fixed value: json |
Maximum Calling Frequency
200 queries/sec.
Sample Request Packet
Basic Form
It is used to add members to the permission group. A maximum of 100 members can be added per request.
{"GroupId": "@TGS#_@TGS#cAVQXXXXXX", // Group to operate on (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group to operate on (required)"MemberList": [ // A maximum of 100 members can be added at once.{"Member_Account": "tommy" // Permission group member ID to be added (required)},{"Member_Account": "jared"}]}
Description of Request Packet Fields
Field | Type | Attribute | Description |
GroupId | String | Required | ID of the group to operate on |
PermissionGroupId | String | Required | ID of the permission group to operate on |
MemberList | Array | Required | Array of permission group members to be added |
Member_Account | String | Required | UserID of the permission group member to be added |
Sample Response Packet
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"MemberList": [{"Member_Account": "tommy","Result": 0 // Addition result: 0 indicates success, and 10013 indicates it is already a group member. For other results, refer to the error code description.},{"Member_Account": "jared","Result": 10013}]}
Description of Response Packet Fields
Field | Type | Description |
ActionStatus | String | Result of the request processing OK: Indicates successful processing. FAIL: Indicates failure. |
ErrorCode | Integer | Error code 0: Indicates success. Non-zero: Indicates failure. |
ErrorInfo | String | Error message |
MemberList | Array | Returned result of added group members |
Member_Account | String | Returned group member UserID |
Result | Integer | Addition result: 0: success 10013: Already a group member For other results, refer to the error codes. |
Error Codes
Unless a network error (such as a 502 error) occurs, the HTTP return code for this API is always 200. The real error code and error message are indicated by ErrorCode and ErrorInfo in the response packet body.
Common error codes (60000 to 79999) can be found in the Error Codes document.
The private error codes for this API are as follows:
Error Code | Description |
10002 | Internal server error, Try again. |
10003 | Illegal request command word |
10004 | Invalid parameter. Check if the request is correct based on the error description. |
10007 | Insufficient operation permissions, such as lacking the permission to add members to the permission group |
10013 | Already a permission group member |
10010 | The group does not exist, or it existed in the past but has now been dissolved. |
10015 | Invalid group ID. Check if the group ID is filled in correctly. |
10016 | The developer backend has denied this operation through third-party callback. |
10019 | The requested UserID does not exist. Check if all Member_Accounts in the MemberList are correct. |
110006 | The permission group does not exist, or it existed in the past but has now been dissolved. |
110008 | Invalid permission group ID. Check if the permission group ID is filled in correctly. |
110012 | The number of permission group members exceeds the limit. |
API Debugging Tool
References