本文介绍如何在聊天室中调用服务端接口实现消息撤回。

调用该接口撤回消息后，会触发聊天室消息状态变更事件，事件通知中会包含被撤回的消息 ID。

请求

URI

POST https://{endpoint}/scene/apps/{appKey}/v2/rooms/{roomUuid}/chatrooms/{chatroomId}/recall

• {endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。
• Content-Type：application/json

Header

请求 Header 的设置请参见 请求结构。

路径参数

参数名称	类型	是否必选	描述
appKey	String	是	云信控制台申请的appKey。
roomUuid	String	是	需要撤回的消息所在房间 ID。
chatroomId	String	是	消息所在的聊天室 ID。

请求体参数

参数名称	类型	是否必选	描述
msgId	String	是	需要撤回的消息 ID。
msgTimetag	Long	是	聊天室被撤回消息的时间戳。

请求体示例

json{
    "msgId": "123456",
    "msgTimetag": 16900000000
}

响应

响应参数

参数名称	类型	示例	描述
code	int	0	状态码，0表示成功，具体请参见错误码。
msg	String	Success	业务结果描述，Success表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
cost	String	48ms	处理该请求所消耗的时间。

响应体示例

json{
    "code": 0,
    "msg": "Success",
    "ts": 1619068087795,
    "requestId": "6e507107d1f4447ea731f651dc6d2432",
    "cost": "66ms"
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
400	Invalid parameter.	参数错误	检查接口传参