概述

Webhooks 说明文档可参考:Webhooks 概述
需要申请权限
    开发者后台-设置-关联设置-抖音号管理为小程序经营者申请小程序私信能力
接收用户进入私信会话页事件提供事件如下:
事件名
事件介绍
im_enter_direct_msg
接收用户进入私信会话页事件,用户主动进入私信会话页触发

事件参数

参数
类型
含义
event
string
事件名,唯一标识,im_enter_direct_msg
from_user_id
string
发送方 open_id
to_user_id
string
接收方 open_id
client_key
string
开发者唯一标识
content
string
消息内容,json格式
conversation_short_id
string
会话 ID
server_message_id
string
消息 ID
conversation_type
int
会话类型(1:私聊)
objectId
string
视频 ID,从视频页进入会带上视频 ID
scene_type
int
场景类型
    3:视频页
    4:主页
    5:消息页
    6:直播页
    100:其他
create_time
int
消息创建时间,13位的时间戳
data-im-extra
string
小程序进入私信会话页透传字段
user_infos
list<struct>
用户基本信息,包括:昵称和头像
open_id
string
用户 open_id
nick_name
string
昵称
avatar
string
头像链接
ad_info
string
广告信息,json格式,广告流量进入私信会话页携带
adv_id
int
广告主Id
adv_name
string
广告主名称
ad_id
int
广告计划Id
ad_name
string
广告计划名
creative_id
int
创意Id
promotion_id
int
广告Id
material_title_id
int
广告素材-标题Id
material_image_id
int
广告素材-图片Id
material_video_id
int
广告素材-视频Id
query
string
用户通过小程序跳转私信组件进入私信会话页前所在小程序的query参数,非小程序跳转场景query为""
path
string
用户通过小程序跳转私信组件进入私信会话页前所在小程序的path参数,非小程序跳转场景path为""

事件参数示例

{ "event": "im_enter_direct_msg", "client_key": "aaaoqobz68a71u1", "from_user_id": "aaa-8a0b-4c0f-b04f-feba0e909113", "to_user_id": "aaa-81ec-424c-b738-8693eeaf53ea", "content": "{\"conversation_short_id\":\"@9Vxc1/yDU8sqaS+gN4koEc7912foPPyAOJNyrA+nLFAba/f760zdRmYqig357zEBFWIIcsZD6/UJHKbF2JNw4w==\",\"server_message_id\":\"@9Vxc1/yDU8sqaS+gN4koEc7912foPPyAPZd5qgKuL1UVbfj460zdRmYqig357zEBi2hwzcxjeRsR2HorFuOHvA==\",\"conversation_type\":1,\"create_time\":1681303286088,\"scene_type\":4,\"user_infos\":[{\"open_id\":\"xxxx8a0b-4c0f-b04f-feba0e909113\",\"nick_name\":\"Hs姝羽\",\"avatar\":\"https://p6.douyinpic.com/aweme/720x720/xxxx/tos-cn-i-0813_f2c60a21b05d43e68dd6daffd7d5d733.jpeg?from=3782654143\"},{\"open_id\":\"xxxx-81ec-424c-b738-8693eeaf53ea\",\"nick_name\":\"广汽传祺张掖华逸店\",\"avatar\":\"https://p6.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813_5d0c96b34bcc4068bb6f9f43b609448a.jpeg?from=3782654143\"}],\"data-im-extra\":\"123456789\",\"query\":\"cptName=button\",\"path\":\"page/componentTpl/componentTpl\"}" }