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

私信/群管理

收藏
我的收藏

能力介绍​

本能力当前为能力实验室能力,可能会有回收或能力开放范围调整,具体能力说明可在开发者后台控制台-我的应用-能力管理-能力实验室中查看详细说明。​
私信、群管理能力,是抖音开放平台基于抖音及抖音极速版即时通讯基础功能,提供的接口&数据开放服务,支持抖音内的经营类账号通过授权第三方应用获取及发送抖音私信、群消息,并支持丰富的富媒体消息类型,包括不限于文字、图片、视频、消息卡片等。​

使用场景​

成功接入抖音开放平台的 IM 开放能力,可以帮助你在抖音高效连接用户,支持基于会话单元组织相关服务。​
    1.私信服务场景:在经营者账号完成认证&授权的情况下,经营者可以使用开发者搭建的应用实现私信管理,做好客户承接、促活和转化工作。​
    a.支持个性化的消息回复,问候语、自动回复等。开发者可以搭建满足业务诉求的私信收发策略,设置不同的话术和发送时间,避免用户流失,提升留资&交易转化;​
    b.支持多样化的消息卡片,目前支持留资卡片、小程序引导卡片,后续将支持更多样式、覆盖不同需求场景的模板卡片及授权经营组件;​
    c.支持私信发送抖音小程序卡片,通过丰富的小程序引导卡片提升提升小程序活跃,促进复访复购和留资;​
    d.支持配置私信内小程序快捷入口,可以针对不同的账号跳转不同的小程序落地页,帮助用户从私信内更好的复访,获取服务;​
    2.主动私信持续触达场景:在经营者账号完成小程序品牌号&员工号认证及私信能力授权的的情况下,经营者可以使用开发者搭建的应用对用户进行主动私信触达;需要期望持续触达的用户完成对经营者的主动私信授权;​
    a.支持私信场景内的完整消息能力;​
    b.支持对已授权用户进行主动私信持续触达,触达额度为每日一次,每次至多 3 条消息。​
    c.支持在私信/群聊发送小程序主动私信授权卡片、提供小程序内主动私信授权组件,帮助经营者(开发者)更好的积累私域用户;​
    3.群聊场景:在经营者账号完成认证&授权的情况下,经营者可以使用使用开发者搭建的应用实现群管理和群消息发送,进一步提升群活跃。​
    e.支持豁免万粉条件创建粉丝群,人数上限对比普通群更高;​
    f.搭配群消息收发能力,可灵活管理群消息内容;​
    g.群主、管理员运营工具更丰富:入群审核、群通知、群推广、群裂变等,群主更新的作品、直播内容支持自动同步群内;​
    h.支持更高效的群管理,通过接口提升建群效率并自定义参数,可实时获取群信息及状态,用于定向推广。同时支持入群审批接口能力,可满足开发者自定义群门槛设定;​
    i.支持配置群内小程序快捷入口,可以针对不同的群跳转不同的小程序落地页,帮助用户从群内更好的复访,获取服务;​

能力使用说明​

    1.在私信/群管理能力的场景下,抖音用户可分为两类:抖音C端用户和经营用户(给抖音用户提供服务的达人等);​
    2.第三方开发者取得经营用户授权后方可使用私信/群相关能力;该能力仅对经营用户开放授权,目前仅支持企业号、小程序品牌号、小程序员工号使用,目前支持两种授权方式:​
    a.移动网站应用仅支持 web 扫码授权,详见抖音开放平台授权介绍;​
    b.小程序开发者可以通过绑定品牌号/员工号,并发起能力授权,详见小程序品牌号/员工号介绍;​
    3.一个用户仅同时只可授权给一个应用;已经授权用户可以在设置-账号与安全-授权管理-经营授权中查看 / 取消 已授权的 im 能力;​
    4.接口调用额度:暂不支持提额申请或付费购买额度,如有特殊需求请通过平台在线咨询入口转人工客服/提交非技术工单咨询;长期平台将在默认免费额度基础上,支持基于授权账号数自动提额,请关注平台公告;​

能力图谱​

分类
开放场景
开放场景
实现效果
能力描述
交互示例
支持账号类型
开放形态
依赖能力
(自研实现需要接入)
授权项
(自研实现需要完成)
用户承接
进私信
小程序跳转私信​
支持用户在小程序内拉起私信会话​
    小程序品牌号​
    小程序员工号​
    Button​
授权【小程序跳转私信】​
获取用户私信授权​
获取授权的目的:发送主动私信。
    1.获取方式一:
在小程序内,以底部弹窗的形式获取c端用户的私信授权​
    2.获取方式二:
在IM会话内,以卡片的形式获取c端用户的私信授权​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    Button​
(小程序弹窗获取)​
授权【获取用户私信授权】​
    小程序品牌号​
    小程序员工号​
    OpenAPI​
(IM会话内获取)​
授权【发送私信】​
进群聊
小程序跳转加群​
支持用户在小程序内一键加群。需要通过查询群信息OpenAPI先获取群ID​
    小程序品牌号​
    小程序员工号​
    支持小程序内免研配置;​
    Button​
授权【小程序跳转加群】​
发送群聊邀请​
支持在私信内发送进群邀请卡片​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    OpenAPI​
授权【发送私信】​
私信
发送私信
问候语​
支持向进入经营者私信会话页的用户主动打招呼​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    OpenAPI​
授权【发送私信】​
消息回复​
支持在24h内回复用户开口的咨询,可配置自动回复策略​
    OpenAPI​
消息撤回​
支持撤回私信消息 & 接收消息已撤回事件​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    OpenAPI​
主动私信​
获取用户私信授权后,支持每日发送一次主动私信
    每日发送一次主动私信,每次可发送 1-3条消息。​
    OpenAPI​
私信会话管理
私信会话快捷功能​
支持配置个人私信页的底部导航菜单,区分主客态,支持用户引导快速开口、跳转会话、小程序等​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
未开放API,暂仅支持工作台配置​
/​
群聊
发送群消息
群消息发送​
支持向群主/管理员身份管理的粉丝群中批量群发群消息​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    OpenAPI​
授权【发送群消息】​
粉丝群管理
进群问候语​
支持向刚进入群聊的用户打招呼​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
    OpenAPI​
授权【粉丝群管理】​
创建/查询/编辑群信息​
支持经营者通过工作台或开发者提供的接口创建粉丝群、查询群信息、审批入群申请等​
    OpenAPI​
群聊会话管理
群会话快捷功能​
支持用户在经营者的群会话页中快速找到已配置的快捷功能​
    小程序品牌号​
    小程序员工号​
    认证企业号及其员工号(通过绑定为小程序合作号)​
/​
消息类型
发送消息
文本消息​
支持在私信、群聊场景中发送文字消息​
/​
发送私信发送群消息场景​
    OpenAPI​
授权【发送私信】​
或​
授权【发送群消息】​
图片消息​
支持在私信、群聊场景中发送图片消息​
/​
    OpenAPI​
小程序卡片​
支持在私信、群聊场景中发送小程序卡片消息,可设计跳转链接满足各类经营需求​
    OpenAPI​
小程序券​
支持在私信、群聊场景中发送小程序券​
    OpenAPI​
请求主动私信授权卡片​
通过发送「请求主动私信授权卡片」消息,实现在会话内获取用户私信授权​
    OpenAPI​
授权【获取用户私信授权】​
群聊邀请卡片​
支持在私信内发送进群邀请卡片​
    OpenAPI​
授权【发送私信】​
问题引导卡​
支持在私信场景发送问题引导卡​
    OpenAPI​
授权【发送私信】​
接收消息
文本消息​
支持在私信、群聊场景中接收文字消息​
/​
    OpenAPI​
授权「接收私信消息事件」scope: im.direct_message​
用户本地图片消息​
支持在私信、群聊场景中接收用户发送的本地图片消息​
/​
    OpenAPI​
授权「多媒体消息」scope:im.multimedia_message​
用户本地视频消息​
支持在私信、群聊场景中接收用户发送的本地视频消息​
/​
    OpenAPI​
授权「多媒体消息」scope:im.multimedia_message​

准入条件​

抖音内的经营者账号,通过第三方应用获取及发送抖音私信、群消息,需要“第三方应用”“经营者抖音号”分别满足以下条件:​

第三方应用​

能力的准入条件如下:​
    1.应用已入驻抖音开放平台,且上线为“正式应用”​
    2.应用类型为“移动应用”或“网站应用”​
    3.应用须为面向经营者的ToB SaaS,功能模块以“互动管理(私信/群/评论等)”为主(ToC类应用、内容创作工具类应用暂不做准入)​
同时,对于实验室能力,平台保留定期对应用进行走查、回收能力的权限。可能回收能力的原因,包括不限于:​
    1.接入3个月内,scope下的OpenAPI日均调用OpenID数未达到100;若应用触发能力回收条件,平台可能通过站内信触达开发者提醒,30天后若仍未达标,则进行能力回收;开发者如有特殊原因希望保留,可通过平台首页客服入口转人工客服提交工单申请​
    2.发现应用绕过平台风控规则,或存在不符合抖音开放平台运营规范的行为,平台可能通知开发者同时、即刻回收相关权限​

经营者抖音号​

当前准入条件:小程序品牌号及员工号、认证企业号及其员工号;后续将逐步拓展能力开放的经营者范围。​

特殊说明​

    1.本功能是平台为开发者提供的实验室能力,平台有权利根据法律法规变更、自身业务调整等原因,修改/关闭功能,或变更功能的开放范围。​
    2.若对本文档所述能力有疑问,请通过抖音开放平台首页-在线咨询提交技术工单,或键入“转人工”咨询人工客服,相关问题将流转至开放能力建设团队值班同学​

接入流程​

接入前准备​

应用入驻​

开发者需要入驻抖音开放平台,创建一个以消息管理为核心功能场景之一的网站应用,获取应用 clientkey。​

接入抖音授权

目前消息管理相关能力仅支持 web 扫码授权。

能力申请​

开发者可在抖音开放平台“控制台-能力管理-能力实验室”中申请,具体步骤见下图:​
步骤
能力申请步骤描述
1
    在抖音开放平台“控制台-能力管理-能力实验室”中找到“私信/群消息管理”能力,点击“申请开通”​
2
    选择需要开通的功能(scopes),并填写&提交申请材料​
    注意事项:​
    私信/群消息管理能力下scopes支持同时申请多个,但最终准入为scope粒度,可能存在部分scope申请通过、部分未通过的情况;开发者如判断未通过功能必要,可重新提交材料继续申请;​
    申请信息及材料请务必按照规则要求完整填写&提交,若材料不完整或信息不符合要求,审核默认不通过​
3
    等待审核通过;​
    注意事项:能力上线初期,各项准入标准仍在持续完善中,申请量大且人工审核成本高,暂定审核周期在7个工作日左右,请开发者耐心等待​

各能力使用步骤及规则详解​

私信管理​

步骤
能力使用步骤描述
1
请求用户授权抖音私信消息收发
    增加授权项:开发者需要先在合适的场景及实际,引导用户进行「私信消息管理」能力的授权;​
    开发者依据自己业务情况,在自己的应用内提供拉起抖音web授权页面的入口,并引导用户打开抖音,扫码完成授权;​
    用户账号身份校验:当开发者申请的授权项包含「私信消息管理」时,抖音会自动校验该用户账号身份是否满足授权条件;当用户账号身份不满足条件时,授权失败(后续会在redict_url中提示授权失败的scopes,需求流程中)​
    是否支持授权多应用:否;仅支持一个用户授权一个应用「私信消息管理」权限​
用户账号身份不满足条件:​
用户账号身份满足条件:​
2
使用限制
场景一:默认仅支持消息回复
    仅支持消息回复,需要开发者前置订阅“收到私信消息事件”,从 webhook 解析出 msg_id 字段,时效为 24小时。​
    仅支持消息回复,在用户未发送下一条消息前,24小时内可向用户发送 6条 消息​
    默认支持的消息类型:文字、图片、授权账户自己投稿的公开视频(须通过video.list.bind请求用户授权);消息卡片须在获取「消息卡片管理 im.message_card」「小程序引导卡片 im.microapp_card」权限后,遵循相关卡片创建/审核/内容规则进行消息发送​
    非互关时,不支持图片和视频消息(同app内发消息),接口在文字消息基础上,额外支持了“非互关发送消息卡片”能力​
场景二:用户主动进入私信会话页
    需要开发者订阅“用户进入私信会话页webhook能力”,从 webhook 解析出相关字段,同时调用本接口时 scene 字段要传 im_enter_direct_msg​
    在接收到用户进入私信会话页事件 30s 内,可使用该接口发送消息,单次可发最多 3条 消息,单日最多 3次,两次发送时间需间隔 1小时 以上(最新规则以抖音 app 内发送消息为准)​
    调用本接口时 scene 字段需传入 im_enter_direct_msg​
    需要开发者订阅“用户进入私信会话页webhook能力”,从 webhook 解析 conversation_short_id 字段​
    用户每次进入会话页触发接收用户进入会话页事件 webhook​
    开发者需要在接收用户进入私信会话页事件 webhook 30 秒内,调用本接口发送消息​
    对于每条接收用户进入会话页 webhook,开发者最多可以调用 3 次本接口,发送 3 条消息;单日最多回复 3 条 webhook (单日总计可向同一用户发送 1 - 9 条消息)​
    两次回复 webhook 的时间间隔需在 1 小时以上​
    最新规则以抖音 app 内发送消息为准​
3
消息发送成功后,用户侧接收消息
    消息审核&风控:消息内容会通过抖音内容审核&反作弊校验,若出现违规,该消息仅发送方自己可见,接收方无法看到;对用户举报、极端作弊case,可能导致抖音经营者(授权使用开发者应用的账号)账号封禁、开发者应用权限收回等处罚;因此,开发者有义务监管使用其服务的抖音用户合规使用抖音消息收发能力​
    App内展现:消息发送成功后,将在用户的抖音/抖音极速版app私信会话页内展现​
    私信会话页hint提示:​

群消息管理​

步骤
能力使用步骤描述
1
请求用户授权抖音群消息收发
    增加授权项:开发者需要先在合适的场景及实际,引导用户进行「群消息管理」能力的授权;​
    开发者依据自己业务情况,在自己的应用内提供拉起抖音web授权页面的入口,并引导用户打开抖音,扫码完成授权;​
    用户账号身份校验:当开发者申请的授权项包含「群消息管理」时,抖音会自动校验该用户账号身份是否满足授权条件;当用户账号身份不满足条件时,授权失败(后续会在redict_url中提示授权失败的scopes,需求流程中)​
    是否支持授权多应用:否;仅支持一个用户授权一个应用「群消息管理」权限​
用户账号身份不满足条件:​
用户账号身份满足条件:​
2
接收粉丝群消息
获取方式:订阅群消息回调事件​
    群聊消息事件:订阅此事件可获取该授权用户创建的粉丝群内产生的所有消息​
2-1
调用接口发送抖音粉丝群消息限制
默认支持的消息类型:文字、图片、授权账户自己投稿的公开视频(须通过video.list.bind请求用户授权);消息卡片须在获取「消息卡片管理 im.message_card」「小程序引导卡片 im.microapp_card」权限后,遵循相关卡片创建/审核/内容规则进行消息发送​
3
消息发送成功后
    消息审核&风控:消息内容会通过抖音内容审核&反作弊校验,若出现违规,该消息仅发送方自己可见,接收方无法看到;对用户举报、极端作弊case,可能导致抖音经营者(授权使用开发者应用的账号)账号封禁、开发者应用权限收回等处罚​
    App内展现:消息发送成功后,将在用户的抖音/抖音极速版app粉丝群会话内展现​
    进入群聊会话页notice提示:“为提供更好的服务,群主可能使用第三方工具管理群聊信息”​

消息&卡片类型使用规范​

卡片类型
使用规范
样式
文本消息
    建议字数<100,具体以抖音app内规则为准,接口侧无额外限制​
-​
图片消息
    需通过tool.image.upload上传图片url换取media_id来发送;基于用户隐私&风控策略考量,当前图片消息暂不支持webhook下载,需到抖音app端查看​
-​
视频消息
    仅支持授权账户自己投稿的公开视频(须通过video.list.bind请求用户授权)​
-​
小程序引导卡片
需获取im.microapp_card权限;无需用户授权​
    同一小程序,可以配置多张小程序引导卡片模板,调用限制为近 30 天可创建 / 更新小程序引导卡片模板 100 次​
    跳转能力:仅支持跳转小程序,可跳转小程序任意页面;两种实现方式:​
    方案一:传appid+query+path:发消息接口直接传入,无需提前生成​
    方案二:传schema+app_id:「schema」生成方式:​
    在小程序界面点击右上角 ... > 分享 > 复制链接​
注:平台将对小程序跳转链接合法性进行校验,不合法链接会导致消息发送失败​
留资卡片
需获取im.message_card权限;需要用户授权​
    默认可配置字段:姓名、城市、手机号(最少选1个)​
    当前行业定制字段仅支持“意向车系”,其他行业暂无特定字段​

接口列表​

OpenAPI 列表​

请求域名:https://open.douyin.com
产品能力
OpenAPI
描述
对应Scope权限
权限名
是否需要用户授权
私信管理​
发送抖音私信消息​
im.direct_message​
私信消息管理:接收和发送抖音私信消息​
是​
查询授权服务私信的 C 端用户列表​
im.direct_message​
私信消息管理:接收和发送抖音私信消息​
是​
群消息管理​
发送抖音群聊消息​
im.group_message​
群消息管理:接收和发送抖音群聊消息​
是​
粉丝群管理​
查询群信息​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
创建粉丝群​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
查询用户剩余建群额度​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
设置进群问候语&群公告​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
取消进群问候语&群公告配置​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
查询群主所在群的用户入群申请状态
查询群主所在群的用户入群申请状态​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
意向用户识别​
互动用户记录查询​
user.intention​
意向用户管理​
是​
消息卡片管理​
创建/更新留资卡片​
im.message_card​
消息卡片管理​
是​
查询留资卡片​
im.message_card​
消息卡片管理​
是​
删除留资卡片​
im.message_card​
消息卡片管理​
是​
小程序引导卡片​
创建/修改小程序引导卡片模板​
im.microapp_card​
小程序引导卡片模板管理​
否​
查询小程序引导卡片模板​
im.microapp_card​
小程序引导卡片模板管理​
否​
删除小程序引导卡片模板​
im.microapp_card​
小程序引导卡片模板管理​
否​
私信/群消息撤回​
撤回私信、群聊消息​
im.recall_message​
消息撤回管理​
是​
上传图片工具​
上传图片工具​
tool.image.upload​
上传图片​
否​

Webhook 事件订阅​

产品能力
Webhook
事件名
Scope权限
权限名
需用户授权
私信管理​
im_send_msg​
im.direct_message​
私信消息管理:接收和发送抖音私信消息​
是​
im_receive_msg​
im.direct_message​
私信消息管理:接收和发送抖音私信消息​
是​
im_enter_direct_msg​
im.direct_message​
私信消息管理:接收和发送抖音私信消息​
是​
群消息管理​
im_group_send_msg​
im.group_message​
群消息管理:接收和发送抖音群聊消息​
是​
im_group_receive_msg​
im.group_message​
群消息管理:接收和发送抖音群聊消息​
是​
意向用户识别​
new_video_digg​
user.intention​
意向用户管理​
是​
new_follow_action​
user.intention​
意向用户管理​
是​
粉丝群管理​
group_fans_event​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​
enter_group_audit_change​
im.group_fans.create_list​
应用可通过你的抖音帐号创建粉丝群,并查询群信息​
是​