セッショングループデータの削除
Feature Overview
This API is used to delete users' conversation group data.
Note:
Conversation grouping and Conversation Marking operate independently from the recent contacts list. The REST API supports CRUD operations for conversation grouping, Standard Conversation Marking, and Custom Conversation Marking fields.
Each user can create up to 20 conversation groups. A session can join multiple groups. The session cap is set at 1000, and exceeding it will return error code: 51008.
Session tags and session custom fields have a combined upper limit of 1000 sessions. Exceeding this limit will return error code: 51008.
Conversation grouping and marking features require enabling Pro Edition、Pro Plus Edition or Enterprise Edition. The number of cloud sessions that can be pulled is limited by the Number of Conversations to Pull in the Chat basic package. If the number of grouped or marked sessions exceeds the corresponding limit, complete session retrieval may fail. You can upgrade the Chat package version to increase the cloud session limit.
API Calling Description
Sample request URL
https://xxxxxx/v4/recentcontact/del_contact_group?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.comTokyo: adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/recentcontact/del_contact_group | 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, which should always be json. |
Maximum call frequency
200 calls per second
Sample request
{"From_Account": "user_0001","GroupName": ["group_0001" // only one conversation group can be deleted at a time.]}
Request fields
Field | Type | Required | Description |
From_Account | String | Yes | Fill in UserID, request to delete conversation group for this user. |
GroupName | Array | Yes | List of conversation groups to be deleted. Currently, only one conversation group can be deleted at a time. |
Sample response
{"GroupItem": [{"GroupName": "group_0001","GroupId": 1}],"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
Response fields
Field | Type | Description |
GroupItem | Array | Group object to be deleted. |
GroupName | String | Name of the conversation group to be deleted. |
GroupId | Integer | ID of the conversation group to be deleted. |
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.The following table describes the error codes specific to this API:
Error Code | Description |
50001 | The requested UserID has not been imported to Chat. Please import the UserID first. |
50002 | Incorrect request parameter. Check your request according to the error description. |
50003 | The request requires app admin permissions. |
50004 | Internal server error. Please try again. |
50005 | Network timeout. Try again later. |
51009 | The specified conversation group was not found. Please verify that the group name is correct. |
51011 | The conversation group name contains more than 64 bytes. |
51013 | The current version does not support conversation grouping. To use this feature, please upgrade to the Pro edition, Pro edition Plus, or Enterprise edition. |
API Debugging Tool