グループのカスタムプロパティをクリアします
Feature Overview
This API is used by the app admin to clear custom group attributes.
API Calling Description
Applicable group types
Group Type ID | RESTful API Support |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as the meeting group (Meeting) in the new version. |
AVChatRoom | Yes |
Community | No |
Sample request URL
https://xxxxxx/v4/group_open_http_svc/clear_group_attr?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.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/clear_group_attr | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
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
Clear the custom attributes of a group:
{"GroupId": "@TGS#aC5SZEAEF"}
Request fields
Field | Type | Required | Description |
GroupId | String | Yes | ID of the group whose custom attributes are to be cleared |
Sample response
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode":0}
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 |
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. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | No operation permissions. This error occurs when, for example, a group of this type does not support custom attribute operations. |
10010 | The group does not exist or has been deleted. |
10015 | Invalid group ID. Check whether the group ID is entered correctly and whether the group exists. |
10045 | The size of the custom attribute key exceeds the limit of 32 bytes. |
10046 | The size of the custom attribute value exceeds the limit of 4000 bytes. |
10047 | The number of custom attribute keys exceeds the limit of 16. |
10048 | The total size of custom attribute values exceeds the limit of 16000 bytes. |
10049 | The frequency of writing custom attributes to a group exceeds the limit. You can add, delete, or modify them for up to 5 times per second. |
