이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.
Docs Overview/
Chat/
서버 API/
RESTful 인터페이스/
메시지 관련/
메시지 삭제/
지정 사용자가 보낸 메시지 삭제하기/

지정 사용자가 보낸 메시지 삭제하기

Feature Overview

This API can be used to recall the messages sent by a specified user among the last 1,000 messages.

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
No
Community
Yes
These are the preset group types in Chat. For more information, see Group System.
Note
This API recalls messages that are in historical message storage, but audio-video groups (AVChatRoom) do not support historical message storage. Therefore, this API does not take effect when it is used to recall messages for a user in an audio-video group (but no error will be returned).
This API currently supports silent recall only. A recalled message will be marked as recalled on the server, and the client will not be notified of the recall. The client can know that the message is recalled only when it pulls roaming messages.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/delete_group_msg_by_sender?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.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/delete_group_msg_by_sender
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating 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

Recall the messages sent by a specified user among the last 1,000 messages of a group:
{
    "GroupId": "@TGS#2C5SZEAEF",    // Required
    "Sender_Account": "leckie"      // Required
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
ID of the group where messages are to be recalled
Sender_Account
String
Yes
ID of the sender of the messages to be recalled
TopicId
String
No
Topic ID, which indicates message recall in the corresponding topic and applies only to topic-enabled communities.

Sample response

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode":0
}

Response fields

Field
Type
Description
ActionStatus
String
Request result. OK: successful; FAIL: failed
ErrorInfo
String
Error information
ErrorCode
Integer
Error code. 0: Successful; other values: Failed

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.
10003
Invalid command word.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10007
No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Use the correct group ID.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References