Overview
A group administrator recalls a message sent by another group member.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/messages/recall
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| from_id | string | Yes | Sender ID of the message to recall. | |
| target_id | string | Yes | Message recipient; for a group, this is the group ID. | |
| channel_type | int | Yes | Conversation type: 1 for private chat; 2 for group chat. | |
| msg_id | string | Yes | ID of the message to recall. | |
| msg_time | int | Yes | Send time of the message to recall. | |
| exts | map | No | Extended information. |
Request example
POST /jim/messages/recall HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"from_id":"userid1",
"target_id":"group1",
"channel_type":2,
"msg_id":"xxxxxxxxxx",
"msg_time":1731234567823,
"exts":{
"k1":"v1",
"k2":"v2"
}
}
Response example
{
"code":0,
"msg":"sucess"
}
Response codes
| Response codes | Description |
|---|