事件列表
收藏
我的收藏

事件目录

事件名	需要scope	描述
create_video	aweme.forward（默认开通）	用户使用开发者应用分享视频到抖音（携带分享id)
authorize	无	抖音用户授权给开发者APP
unauthorize	无	抖音用户解除授权，推送事件给开发者APP
im_receive_msg	im.direct_message	接收私信，用户收到私信触发
im_send_msg	im.direct_message	发送私信，用户发送私信触发
im_enter_direct_msg	im.direct_message	接收用户进入私信会话页事件，用户主动进入私信会话页触发
im_group_receive_msg	im.group_message	接收群消息事件
im_group_send_msg	im.group_message	发送群消息事件
enter_group_audit_change	im.group_fans.create_list	用户加群申请
group_fans_event	im.group_fans.create_list	用户加群成功
contract_authorize	无	用户给应用经营关系（scope名为xxx.bind，或私信相关能力）授权
contract_unauthorize	无	用户解除应用经营关系（scope名为xxx.bind，或私信相关能力）授权
new_video_digg	user.intention	接收用户点赞事件
new_follow_action	user.intention	接收用户关注事件
union_auth_info_for_c	unionauth.identification	联合授权完成后，对c端应用进行授权信息通知
union_auth_info_for_b	unionauth.identification	联合授权完成后，对b端应用进行授权信息通知

当前抖音用户是指: 授权给开发者应用的抖音用户。其中 im 事件，需要当前抖音用户是企业号留资是指: 用户留下的咨询信息主页留资是指: 用户在账户主页进入商业化组件留下的联系信息

消息结构

统一结构

json复制
{
  "event": "",
  "from_user_id": "",
  "to_user_id": "",
  "client_key": "",
  "content": {}
}

from_user_id 即为 open_id。

不同的 event 对应不同的 content 具体事件结构体见下方 schemas 定义。

open-api 订阅事件接口

获取事件订阅状态

Method	HTTP request	Description
获取事件订阅状态	GET /event/status/list/	获取事件订阅状态

更新应用推送事件订阅状态

Method	HTTP request	Description
更新应用推送事件订阅状态	GET /event/status/update/	更新应用推送事件订阅状态

事件结构

JSON复制
create_video
{
    "event": "",       //事件名为create_video
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "item_id": "", //创建的视频id
        "share_id": "" //标识分享的share_id
    }
}

JSON复制
authorize
{
    "event": "",       //事件名为authorize
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "scopes": []   //授权scope列表
    }
}

JSON复制
unauthorize
{
    "event": "",       //事件名为unauthorize
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "scopes": []   //授权scope列表
    }
}

JSON复制
im_receive_msg
{
    "event":"",          //事件名为im_receive_msg
    "client_key":"",     //使用应用的client_key
    "from_user_id":"",   //事件发起用户user_id
    "to_user_id":"",     //事件接收用户user_id
    "content":{}
}

JSON复制
im_send_msg
{
    "event":"",         //事件名为im_send_msg
    "client_key":"",    //使用应用的client_key
    "from_user_id":"",  //事件发起用户user_id
    "to_user_id":"",    //事件接收用户user_id
    "content":{}
}

JSON复制
im_enter_direct_msg
{
    "event":"",        //事件名为im_enter_direct_msg
    "client_key":"",   //使用应用的client_key
    "from_user_id":"", //事件发起用户user_id
    "to_user_id":"",   //事件接收用户user_id
    "content":{}
 }

JSON复制
im_group_receive_msg
{
    "event":"",       //im_group_receive_msg
    "client_key":"",  //使用应用的client_key
    "from_user_id":"",//事件发起用户user_id
    "to_user_id":"",  //事件接收用户user_id
    "content":{}
 }

JSON复制
group_fans_event
{
    "event":"",       //igroup_fans_event
    "client_key":"",  //使用应用的client_key
    "from_user_id":"",//事件发起用户user_id
    "to_user_id":"",  //事件接收用户user_id
    "content":{}
 }

JSON复制
enter_group_audit_change
{
    "event":"",       //enter_group_audit_change
    "client_key":"",  //使用应用的client_key
    "from_user_id":"",//事件发起用户user_id
    "to_user_id":"",  //事件接收用户user_id
    "content":{}
 }

JSON复制
im_group_send_msg
{
    "event":"",       //im_group_send_msg
    "client_key":"",  //使用应用的client_key
    "from_user_id":"",//事件发起用户user_id
    "to_user_id":"",  //事件接收用户user_id
    "content":{}
 }

JSON复制
contract_authorize
{
    "event": "",       // 事件名为contract_authorize
    "from_user_id": "",// 事件发起用户的open_id
    "client_key": "",  // 事件应用的client_key
    "content": "{\"scopes\":[\"经营Scope\"],\"timestamp\":123456789}" // 用户授权的经营Scope和事件时间戳
}

JSON复制
contract_unauthorize
{
    "event": "",       // 事件名为contract_unauthorize
    "from_user_id": "",// 事件发起用户的open_id
    "client_key": "",  // 事件应用的client_key
    "content": "{\"scopes\":[\"经营Scope\"],\"timestamp\":123456789}" // 用户解除授权的经营Scope和事件时间戳
}

JSON复制
new_video_digg
{
  "event": "new_video_digg",
  "client_key": "awr8bfr64vxgk036",
  "from_user_id": "5adb9d61-b91a-4382-8252-b0cea8793e35",
  "to_user_id": "e3af6e1d-d83a-4116-8f9f-5cb8ac2413c7",
  "content": "{\"action_type\":1,\"action_time\":1686817996,\"item_id\":\"@9VwWjvGUTp9kKW+ma4huFs791WPtO/mAPpx3rg6nL1kRbfn/60zdRmYqig357zEBDoyWkKJYf4Ae9sL0fd9gYw==\"}",
  "log_id": "20230615163316517143EDD4CEF10721B6"
}

JSON复制
new_follow_action
{
  "event": "new_follow_action",
  "client_key": "awr8bfr64vxgk036",
  "from_user_id": "5bfa0218-477c-4d51-865c-64f0588794a6",
  "to_user_id": "e3af6e1d-d83a-4116-8f9f-5cb8ac2413c7",
  "content": "{\"action_type\":1,\"action_time\":1686811643}",
  "log_id": "202306151447300000000000005369C6D"
}

JSON复制
{ 
    "event": "union_auth_info_for_c",            //事件名为union_auth_info_for_c 
    "from_user_id": "",                          //授权方user_id，加密 
    "to_user_id": "",                            //被授权方user_id，加密 
    "client_key": "",                            // 小程序id 
    "content":"{ 
        \"c_client_key\":\"xxxxxx\",             // c端应用id
        \"c_open_id\":\"xxxxxxx\",               // c端openid
        \"b_client_key\": \"xxxxxxxx\",          // b端应用id 
        \"b_open_id\": \"xxxxx\"                 // b端openid
    }" 
}

JSON复制
{ 
    "event": "union_auth_info_for_b",            //事件名为union_auth_info_for_c 
    "from_user_id": "",                          //授权方user_id，加密 
    "to_user_id": "",                            //被授权方user_id，加密 
    "client_key": "",                            // 小程序id 
    "content":"{ 
        \"c_client_key\":\"xxxxxx\",             // c端应用id
        \"c_open_id\":\"xxxxxxx\",               // c端openid
        \"b_client_key\": \"xxxxxxxx\",          // b端应用id 
        \"b_open_id\": \"xxxxx\"                 // b端openid
    }" 
}