事件列表

事件目录

事件名

需要scope

描述

create_video

aweme.share(默认都有)

用户使用开发者应用分享视频到抖音(携带分享id)

authorize

抖音用户授权给开发者APP

unauthorize

抖音用户解除授权,推送事件给开发者APP

receive_msg

enterprise.im

当前抖音用户收到的私信消息具体类型

enter_im

enterprise.im

抖音用户进入当前抖音用户的私信对话框

dial_phone

enterprise.im

抖音用户拨打当前抖音用户的个人主页智能电话

website_contact

enterprise.im

抖音用户在当前抖音用户的转化页留资

personaltabcontact

enterprise.im

抖音用户在当前抖音用户的主页留资

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

消息结构

统一结构

{
  "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/

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




事件结构

create_video
{
    "event": "",       //事件名为create_video
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "item_id": "", //创建的视频id
        "share_id": "" //标识分享的share_id
    }
}
authorize
{
    "event": "",       //事件名为authorize
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "scopes": []   //授权scope列表
    }
}
unauthorize
{
    "event": "",       //事件名为unauthorize
    "from_user_id": "",//事件发起用户user_id
    "client_key": "",  //使用应用的client_key
    "content": {
        "scopes": []   //授权scope列表
    }
}
receive_msg
{
    "event": "",         //事件名为unauthorize
    "from_user_id": "",  //事件发起用户user_id
    "to_user_id": "",    //事件接收用户user_id
    "client_key": "",    //使用应用的client_key
    "content": {
        "description": "" //具体见私信事件列表
    }
}
enter_im
{
    "event": "",         //事件名为enter_im
    "from_user_id": "",  //事件发起用户user_id
    "to_user_id": "",    //事件接收用户user_id
    "client_key": "",    //使用应用的client_key
    "content": {
        "scene": "",     //进入对话来源场景["video", "homepage"]
        "object": ""     //来源场景对应id(video对应视频id)
    }
}
dial_phone
{
    "event": "",         //事件名为dial_phone
    "from_user_id": "",  //事件发起用户user_id
    "to_user_id": "",    //事件接收用户user_id
    "client_key": "",    //使用应用的client_key
}
website_contact
{
    "event": "",         //事件名为website_contact
    "from_user_id": "",  //事件发起用户user_id
    "to_user_id": "",    //事件接收用户user_id
    "client_key": "",    //使用应用的client_key
}
personal_tab_contact
{
    "event": "",         //事件名为personal_tab_contact
    "from_user_id": "",  //事件发起用户user_id
    "to_user_id": "",    //事件接收用户user_id
    "client_key": "",    //使用应用的client_key
}
诚邀您对本文档易读易用性进行评价
好用
不好用