This API is used by the app admin to clear custom group attributes.
Group Type ID | RESTful API Support |
---|---|
Private | No. Same as work groups (Work) in the new version. |
Public | No |
ChatRoom | No. Same as meeting group (Meeting) in the new version. |
AVChatRoom | Yes |
Community | No |
These are the preset group types in IM. For more information, see Group System.
https://xxxxxx/v4/group_open_http_svc/clear_group_attr?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Overview.
Parameter | Description |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com |
v4/group_open_http_svc/clear_group_attr | Request API |
sdkappid | SDKAppID assigned by the IM console when an app is created |
identifier | App admin account. For more information, please see the App Admin section in Login Authentication. |
usersig | Signature generated in the app admin account. For details on how to generate the signature, please see Generating UserSig. |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format, which should always be json . |
200 calls per second
{
"GroupId": "@TGS#aC5SZEAEF"
}
Field | Type | Required | Description |
---|---|---|---|
GroupId | String | Yes | The ID of the group for which you want to clear custom attributes |
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
Field | Type | Description |
---|---|---|
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Error code. 0 : successful; other values: failed |
ErrorInfo | String | Error information |
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), please 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. Use a correct group ID. |
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. |
Was this page helpful?