发送私信消息

在线调试

​使用限制​

•​需要申请权限在开发者后台-设置-关联设置-抖音号管理为小程序经营者申请小程序发送私信能力，当前仅支持一个用户授权一个应用；​

•​当前开放用户范围：认证企业号及其员工号和小程序品牌号及员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围。​

•​小程序通过试运营期。​

​使用场景​

​场景一：回复私信消息​

•​调用本接口时 scene 字段可选传入 im_reply_msg。​

•​需要开发者订阅“接收私信消息事件”，从 webhook 解析出 msg_id 字段，时效为 24 小时。​

•​仅支持消息回复，在用户未发送下一条消息前，24 小时内可向用户发送 6 条消息。​

•​最新规则以抖音 app 内发送消息为准。​

​场景二：用户主动进入私信会话页​

•​调用本接口时 scene 字段需传入 im_enter_direct_msg。​

•​需要开发者订阅 “接收用户进入私信会话页事件”，从 webhook 解析出 conversation_short_id 字段。​

•​开发者需要在接收用户进入私信会话页事件 webhook 30 秒内，调用本接口发送消息。​

•​对于每条接收用户进入会话页 webhook，开发者最多可以调用 3 次本接口，发送 3 条消息；单日最多回复 3 条 webhook （单日总计可向同一用户发送 1 - 9 条消息）。​

•​两次回复 webhook 的时间间隔需在 1 小时以上。​

•​最新规则以抖音 app 内发送消息为准。​

​场景三：B2B 场景私信触达​

•​调用本接口时 scene 字段需传入 im_b2b_direct_message 。​

•​需要接受方身份为认证企业号及其员工号和小程序品牌号及员工号，且授权过 im.direct_message 私信管理能力。​

•​调用本接口时 content_list 字段必传且最多支持传入 3 条消息，其中必有 1 条小程序卡片消息。​

•​调用本接口时返回值 msg_list 字段表示发送成功的消息 ID 列表。​

•​每对发送方与接收方每日最多互动 1000 条消息。​

​场景四：主动私信持续触达​

•​调用本接口时 scene 字段需传入 im_authorize_message。​

•​有关主动私信的流程，详见小程序主动私信能力概述。​

•​需要发送方身份为认证企业号及其员工号和小程序品牌号及员工号。​

•​消息接收方需要通过主动授权私信 button 组件授权给消息发送方；消息接收方成功授权消息发送方后，消息发送方每自然日可调用 1 次 本接口进行主动私信持续触达场景的消息发送，且限制每自然日最多触达 5​000 个 消息接收方，超过将被系统拦截。​

•​调用本接口时 content_list 字段必传，且最多支持传入 3 条消息。​

•​调用本接口时返回值 msg_list 字段表示发送成功的消息 ID 列表。​

​接口说明​

​基本信息​

​请求头​

​请求参数​

​Query​

​Body​

​content 构造​

​文本 content​

•​text 长度限制为 1000 字。​

•​不可包含外部 url 链接。​

​图片 content​

​视频 content​

​群聊邀请卡片 content​

•​方案一：传入 group_id 。​

◦​group_id 即群聊I D，获取方式如下​

▪​群聊 WebHook，对应 content 字段中的 conversation_short_id 字段。​

▪​创建粉丝群 对应返回值中的 group_id。​

▪​查询群信息，对应返回值中的 group_id。​

•​方案二：传入 group_token。​

◦​ group_token 获取方式需要在 动经营工作台 列表界面，在导入粉丝群后点击 ​＂取群 ID＂＂获取。​

​小程序引导卡片 content​

•​方案一：必传 app_id ＋＋query ＋＋path：发消息接口直接传入，无需提前生成。​

•​方案二：仅传 schema ＋＋app_id：schema 生成方式如下。​

1.​通过接口生成 Generate，通过 expire_time 参数控制过期时间，链接过期后需重新生成。​

2.​在小程序界面点击右上角 ... ＞＞分享 ＞＞复制链接，链接有效时间为 45 天，链接过期后需重新生成。​

​小程序券 content​

•​coupon_id 获取方式详见 询券模板。​

•​activity_id 获取方式详见 询授权用户发放的活动信息。​

​主动私信授权卡片 content​

​问题引导卡 content​

•​发消息，用户点击问题文案后会自动发送点击的问题文案​

•​发链接，用户点击问题文案后会自动跳转到对应小程序中​

​请求示例​

1.​场景一 复消息示例。​

2.​场景二 户主动进入私信会话页示例。​

3.​场景三 B2B 场 景私信触达示例。​

4.​场景四 动私信持续触达示例。​

​响应参数​

​响应示例​

​正常示例​

​异常示例​

​错误码​