抖音开放平台Logo
开发者文档
控制台

接收私信消息撤回事件
收藏
我的收藏

概述​

Webhooks 说明文档可参考:Webhooks 概述
    Scope: im.recall_message​
    新能力上线能力实验室后,经营者可在“控制台-能力管理-能力实验室”中申请​
    后期能力若转为正式开放能力,可在“控制台-能力管理-互动管理”中申请​
接收私信消息撤回事件包括事件如下:​
事件名
事件介绍
im_recall_msg​
撤回私信,用户撤回私信触达​

事件参数​

参数
类型
含义
event​
string​
事件名,唯一标识​
    撤回私信:im_recall_msg​
from_user_id​
string​
撤回方用户 open_id​
to_user_id​
string​
撤回方对应私聊方 open_id​
client_key​
string​
开发者唯一标识​
content​
struct​
具体内容,类型:结构体​
server_message_id​
string​
消息 ID,需要开发者自行将其与先前私信消息事件中的相关字段进行关联​
log_id​
string​
事件推送 log_id ,用于抖音内部排查问题使用​
msg_id​
string​
消息 id​

事件参数示例​

{ "event": "im_recall_msg", "client_key": "awipqx***", "from_user_id": "236ed9d9-2cb3-4d2f-a834-***", "to_user_id": "971d8bed-40b6-417e-a88a-***", "content": "{\"server_message_id\":\"@9VwNxuKKBZ03MXG7M8ooWM791mzu***\"}", "log_id": "02172241112209700000000000000000000ffff0a94***", "msg_id": "3292f6c3e9fba93e0255fdf12558b0224ca64cbf8d489070857c99***" }

注意事项​

    1.私信消息撤回事件在具体内容字段仅返回server_message_id,需要开发者自行将其与先前私信消息事件中的相关字段进行关联;​
    2.授权开发者私信撤回能力的用户 以及 授权用户对应私聊方用户 撤回消息时,均会触发事件。开发者需要根据 Webhook 事件中的from_user_idto_user_id字段进行区分。​
私聊
是否授权
推送 Webhook
A - B​
A 授权 B 未授权​
只向 A 推送事件通知​
A 未授权 B 授权​
只向 B 推送事件通知​
A 授权 B 授权​
A 和 B 都推送事件通知​
A 未授权 B 未授权​
A 和 B 都不推送事件通知​