线索能力开放

我的收藏

PR编号：2024112059215

能力更新说明

版本	说明	更新时间
v1.0.4	支持配置快捷引导、自动引导留资、用户触达计划，相关接口见：2.21-2.29	2025.2
v1.0.3	支持配置企业号自动回复、快捷回复，相关接口见：2.11-2.20	2025.1
v1.0.2	支持自定义「一键收集电话」文案，相关接口见：2.7-2.10	2024.1
v1.0.1	•支持发送组件信息，包括高级在线预约，一键留资，电话收集卡片等，接口见2.1，2.2 •支持查询组件相关信息，接口见：2.3-2.5	2024.12

接入私信能力

1.能力申请 & 用户授权

网站应用

•

经营者可在“控制台 - 能力管理 - 能力实验室”中申请私聊消息能力

•

需要用户授权，当前仅支持一个用户授权一个应用

•

当前开放用户范围：线索投广商家；后续将基于抖音经营者实际诉求逐步拓展开放用户范围

•

开发者需要在抖音开放平台“控制台 - 设置 - 开发配置 - Webhooks”为移动/网站应用配置事件回调地址，同时订阅相关事件

与 Webhook 相关的注意事项可以参考 Webhook 概述

注意：私信能力已不支持新增准入，相关能力申请不用提单

问题排查（不要直接拉研发同学进行排查）：
以下问题联系抖音开放平台 OnCall 进行处理：
1.私信能力开通
2.发送组件消息非权限类错误
剩余问题联系企业号线索侧进行处理（2.2 - 2.29），例如：
1.线索组件能力开通
2.线索组件查询、创建
3.发送组件消息权限类错误
4.……

2.接口接入

2.1 发送组件消息

相关接口文档可以参考发送私信消息

基本信息

名称	描述
HTTP URL	https://open.douyin.com/im/send/msg/
HTTP Method	POST
Scope	im.direct_message

请求头

名称	类型	是否必填	描述
Content-Type	string	true	固定值 "application/json"
access-token	string	true	调用 /oauth/access_token/ 生成的 token，此 token 需要经营者授权

请求参数

Query

名称	类型	是否必填	描述	示例
open_id	string	true	调用 /oauth/access_token/ 获取，用户唯一标志	ba253642-0590-40bc-9bdf-9a1334b94059

Body

名称	类型	是否必填	描述	示例
msg_id	string	false	消息id，场景一、场景二必传 •场景一：来源于接收私信消息事件，对应 webhook 的 content 中 server_message_id 字段（有效期为24小时） •场景二：来源于接收用户进入私信会话页事件，对应 webhook 的 content 中 server_message_id 字段（有效期为24小时）	@9VxXwOOLDZg4JyKuOM0+Qc79fadf12foPP+BPpJ3qw2uLFARa/H760zdRmYqig357zEBqu7zZ/C7rfG4tqP82908PQ==
conversation_id	string	false	会话 id，场景一、场景二必传 •场景一：来源于接收私信消息事件，对应webhook 的 content 里的 conversation_short_id 字段（长期有效） •场景二：来源于接收用户进入私信会话页事件，对应webhook 的 content 里的 conversation_short_id 字段（长期有效）	@9fdVxXwOOLDZg4JyKuOM0+Qc7912foPP+BPpJ3qw2uLFARa/H760zdRmYqig357zEBqu7zruZ/C7rfG4tqP82908PQ==
to_user_id	string	true	消息的接收方 open_id	0da22181-d833-447f1241
content	struct	false	消息体，场景一、场景二必传，见下方 content 构造 •文本 content •图片 content •视频 content •留资卡片 content •群邀请卡片 content •小程序引导卡片 content •小程序券 content •主动私信卡片 content •问题引导卡 content •线索组件 content	{"msg_type":1,"text":{"text":"文本消息"}}
scene	string	true	私信场景 •场景一：默认场景，可选传入 im_reply_msg •场景二：用户主动进入私信会话页，必传 im_enter_direct_msg •场景三: B2B场景私信触达，必传 im_b2b_direct_message •场景四：主动私信持续触达，必传 im_authorize_message	im_enter_direct_msg
content_list	[]struct	false	场景三，场景四必传，最多支持三条消息场景三必须包含一条小程序卡片消息见下方 content 构造 •文本 content •图片 content •视频 content •留资卡片 content •群邀请卡片 content •小程序引导卡片 content •小程序券 content •主动私信卡片 content •问题引导卡 content •线索组件 content	{ "msg_type":1,"text":{ "text":"文本消息1" }, "msg_type":10,"applet_card": { "card_template_id": "@9VwNxuKKBZ03MXG7M8ooWM771FjUAMW/BqhMlDebEmyyzJD7cZENrR868oDbX9xx", "path":"api/apiPage/apiPage" "query":"{\"key1\":\"val1\",\"key2\":\"val2\"}" "app_id":"tt3ergjdge84gdwksb" }, "msg_type": 2, "image": { "media_id": "@sssssssss" } }
channel	int	false	发送渠道，调用发送消息的接口时必须传入 1 - 人工：人工回复 2 - 智能：智能客服回复（官方 or isv智能客服） 3 - 自动消息：欢迎语，关键词自动回复等规则配置类的	1

content 构造

在现有消息类型的基础上，额外支持以下消息类型：

消息类型	msg_type	content	示例
一键收集电话	20	`"content": { "msg_type": {$msg_type}, "general_msg_content": { "component_type": {$component_type}, // 线索组件类型 "component_id": {$component_id} // 线索组件 id } }` 注： •{$msg_type} 指代的是表格第二行的消息类型 msg_type •{$component_type} 和 {$component_id} 均来自线索侧相关页面或者接口高级在线预约 •component_type = 1 •component_id = 高级在线预约组件id 线索商品卡 •component_type = 2 •component_id = 线索商品id 招商加盟卡 •component_type = 3 •component_id = 招商加盟商品id 售后订单卡 •component_type = 4 •component_id = 0 这个固定是0 门店 / POI 卡 •component_type = 5 •component_id = 生服poiId 电话收集卡 •component_type = 6 •component_id = 创编卡片id 一键收集电话 •component_type = 8 //一键收集电话组件类型 •component_id = 0 •自定义文案发送：把“自定义「一键收集电话」”接口中的reply_id传到component_id中，即可自定义「一键收集电话」组件的文本，如果不传就是系统默认文案 •一键收集电话组件，从创建自定义的文案，到发送组件的全流程 •代码demo：可见3.2 代码示例中的「一键收集电话」组件，从创编自定义文案到发送企业微信卡 •component_type = 12 •component_id = 企业微信卡id
线索商品卡	21
高级在线预约	16
门店 / POI 卡	22
招商加盟卡	23
售后订单卡	24
电话收集卡	25
企业微信卡	40

响应参数

和线上一致

Webhook 新增字段

开发者消费抖音消息时，对应的组件消息格式及参数：

消息类型	msgType	对外透传消息类型	是否有组件id	触发方式	示例（加粗高亮部分为新增）
分享视频	-	video	否		{ "conversation_short_id": "@9VwDhOCRTcMhM22uc8ptWc791WbvOP+HMpxwrAOiL1MWa/H460zdRmYqig357zEBdsmeO0WyFq81ZGOrbYMEaw==", "server_message_id": "@9VwDhOCRTcMhM22uc8ptWc790GDoPv6CP5R3qwylL1AQZ/P760zdRmYqig357zEBZ0cjjMSP4vw7p3lDw7Mqew==", "conversation_type": 1, "create_time": 1758188113980, "message_type": "video", "source": "", "im_mode": "Unset", "item_id": "@9VwDhOCRTcMhM22uc8ptWc790GDpNPyCPJx5rQqgLlIWbvT860zdRmYqig357zEBY0C3PUup5KDpIW5QR8sPQg==", "content_title": "视频标题", "user_infos": [{ "open_id": "bb227f4c-0036-4056-8428-fe7b5f3fec3d", "nick_name": "at2202", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_61555435571d3781430b41dffce7373c.jpeg?from=3782654143" }, { "open_id": "2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d", "nick_name": "at2201", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502488150000 }
一键收集电话	20	leads_phone_card	否		{ "conversation_short_id": "@9VwDhOCRTcMhM22uc8ptWc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBh7/PnNH674GEk3Xg4tuf3g==", "server_message_id": "@9VwDhOCRTcMhM22uc8ptWc790GDoPvCBPpB5oA6lKFEXaPD960zdRmYqig357zEBaz9O5kCBmBjy0YTazvfWqg==", "conversation_type": 1, "create_time": 1758193500753, "message_type": "leads_phone_card", "source": "", "im_mode": "Unset", //type LeadsPhoneCard struct { // // 标题 // Title string `json:"title,omitempty"` // // 按钮文字 // ButtonText string `json:"button_text,omitempty"` // // 底部文字 // BottomText *string `json:"bottom_text,omitempty"` //} "leads_phone_card": "{\"title\":\"我\",\"button_text\":\"立即预约\",\"bottom_text\":\"提交即发送抖音绑定手机号\"}", "user_infos": [{ "open_id": "3af6e6e5-6dca-5812-86c4-413fa2440ea2", "nick_name": "蓝v婚庆113", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d", "nick_name": "at2201", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502400690000 }
线索商品卡	21	lead_commodity_card	是		{ "conversation_short_id": "@9VwIwfmRWdMjN3X3ZYsqVc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBRiZ5AfXYWc7bz99LFISPpQ==", "server_message_id": "@9VwIwfmRWdMjN3X3ZYsqVc790GDoPvCGPpF1qA6iL1UaafD460zdRmYqig357zEBqd+AcixX6oKBkX0k8bf5fQ==", "conversation_type": 1, "create_time": 1758193730954, "message_type": "lead_commodity_card", "source": "", "im_mode": "Unset", //type LifeLeadsTool struct { // //组件id // Id string `json:"id"` // //标题 // Title string `json:"title"` // //头图 // ImageUrl string `json:"image_url"` // //创建时间，单位：秒 // CreateTime int64 `json:"create_time"` // //商品id // ProductId int64 `json:"product_id"` //} "life_leads_tool": "{\"id\":\"26559327746\",\"title\":\"线索承接页\",\"image_url\":\"https://p26-sign.douyinpic.com/obj/tos-cn-i-hf2m9xxmck/0cdeed1e181f4689b2ade5def7ce1a8f?x-expires=1758214800\\u0026x-signature=ZTL4o4HbtKke8Zycj1scJbL7SYU%3D\\u0026from=4286704254\",\"create_time\":1758008873,\"product_id\":1843333587812393}", "user_infos": [{ "open_id": "9d3b4506-7294-5d2f-aee6-9cf5ace3aa73", "nick_name": "蓝v婚庆113", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "b9b71865-7fea-44cc-8636-727e89f72be9", "nick_name": "at2201", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "component_id": "1843333587812393", "component_status": 1, "index": 1672502400720000 }
高级在线预约	16	premium_online_appointment_card	是		{ "conversation_short_id": "@9VwP3OXCWZloOCf2aN0yVc790GDoPvGAOJdxqQulLFQQavj960zdRmYqig357zEBnE3oJ9maDzmhMGf0vZL3/A==", "server_message_id": "@9VwP3OXCWZloOCf2aN0yVc790GDoPvGAOJ12qgyjJ1IRbPX160zdRmYqig357zEBuujSkOT1XIsJ0i68fSZWfg==", "conversation_type": 1, "create_time": 1758195553589, "message_type": "premium_online_appointment_card", "source": "", "im_mode": "Unset", //type MarketingTool struct { // //组件类型，45-高级在线预约 // LinkType int32 `json:"link_type"` // //头图 // TitleImage string `json:"title_image"` // //创建时间，单位：秒 // CreateTime int64 `json:"create_time"` // //组件id // ComponentId int64 `json:"component_id"` // //标题 // Title string `json:"title"` // //副标题 // SubTitle string `json:"sub_title"` //} "marketing_tool": "{\"link_type\":45,\"title_image\":\"https://p3-saiyan-sign.byteimg.com/aweme-saiyan-private/cv6349bc77u8vqee6ni0~tplv-k9qcquo31z-2000.image?lk3s=e44e97a5\\u0026x-expires=1758799992\\u0026x-signature=WSwv2ejiu7ONtuvleKy1DYFeRMI%3D\",\"create_time\":1662599423,\"component_id\":7140809997826394892,\"title\":\"点击一键领取价格表⬇️⬇️⬇️\",\"sub_title\":\"\"}", "user_infos": [{ "open_id": "_000eVUpyINiqc4u9CMfAce9GgR3Aj6yI9Cn", "nick_name": "深圳广深驾校总部", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-hf2m9xxmck_c9102a1f1b3a4f259e87182d921f4a76.jpeg?from=3782654143" }, { "open_id": "_000DpaOwJdpwJNe-cCMmZGHiTrOZtXjgwyE", "nick_name": "毛士祥", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813_88318e131bcc41efb41713fd4a29fa20.jpeg?from=3782654143" }], "group_info": {}, "component_id": "7140809997826394892", "component_status": 1, "index": 1672502400010000 }
门店/POI卡	22	poi_card	是		{ "conversation_short_id": "@9VwDhOCRTcMhM22uc8ptWc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBh7/PnNH674GEk3Xg4tuf3g==", "server_message_id": "@9VwDhOCRTcMhM22uc8ptWc790GDoPvCFO5J3qA+hLlgWafn560zdRmYqig357zEBRIw5wVLeiX9YOPA3sMrEkQ==", "conversation_type": 1, "create_time": 1758194321474, "message_type": "poi_card", "source": "", "im_mode": "Unset", //type LifePoi struct { // //poiId // Id int64 `json:"id"` // //标题 // Title string `json:"title"` // //图片 // ImageUrl string `json:"image_url"` // //主营类目 // MainCategory []string `json:"main_category"` // //地址 // Address string `json:"address"` //} "life_poi": "{\"id\":7546060909257426982,\"title\":\"测试POI-意向测试门店\",\"image_url\":\"\",\"main_category\":[\"丽人\",\"美发养发\",\"美发养发\"],\"address\":\"新疆维吾尔自治区阿克苏地区沙雅县庐山路华晨大拇指商业广场5楼\"}", "user_infos": [{ "open_id": "3af6e6e5-6dca-5812-86c4-413fa2440ea2", "nick_name": "蓝v婚庆113", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d", "nick_name": "at2201", "avatar": "https://p3.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "component_id": "7546060909257426982", "index": 1672502400800000 }
招商加盟卡	23	investment_franchise_card	是
售后订单卡	24	post_sale_order_card	否
电话收集	25	phone_collection_card	是
团购商品	-	product	是		{ "conversation_short_id": "@9VwIwfmRWdMjN3X3ZYsqVc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBRiZ5AfXYWc7bz99LFISPpQ==", "server_message_id": "@9VwIwfmRWdMjN3X3ZYsqVc790GDoPvCFMp1zrwuhLVcWaPj960zdRmYqig357zEBsmKVz6Ai3uFZVYq0Ku15yQ==", "conversation_type": 1, "create_time": 1758194529895, "message_type": "product", "source": "", "im_mode": "Unset", //type Product struct { // // 商品ID // ProductId int64 `json:"product_id,omitempty"` // // 商品名称 // ProductName string `json:"product_name,omitempty"` // // 商品图片链接 // ImageUrl string `json:"image_url,omitempty"` // // 应付价 // ActualAmount int64 `json:"actual_amount,omitempty"` // // 已售量 // SoldQty int64 `json:"sold_qty,omitempty"` // // 商品详情页链接 // ProductUrl string `json:"product_url,omitempty"` // // 商品图片uri // ImageUri string `json:"image_uri,omitempty"` // // 来客pc商品详情页链接 // PcProductUrl string `json:"pc_product_url,omitempty"` // // 原价 // OriginAmount int64 `json:"origin_amount,omitempty"` // // 折扣 // DiscountDesc string `json:"discount_desc,omitempty"` // // 实际价格后缀 "起" // ActualAmountSuffix string `json:"actual_amount_suffix,omitempty"` // // 商品类型描述日历房 // ProductTypeDesc string `json:"product_type_desc,omitempty"` // // 商品品类 // ProductCategory string `json:"product_category,omitempty"` // // 出行人数（xx 成人 xx 个儿童） // TravelerNum string `json:"traveler_num,omitempty"` //} "product": "{\"product_id\":1792588596209674,\"product_name\":\"欢聚\|清汤1份2人餐\",\"image_url\":\"https://p9-sign.douyinpic.com/tos-cn-i-hf2m9xxmck/c72a14d204bc4a47b91bc5c62304aff6~noop.jpeg?lk3s=4a7c4021\\u0026x-expires=1758214800\\u0026x-signature=qxVIgkngwMn%2BSa0IsIv4JaUCOLw%3D\\u0026from=1249656865\",\"actual_amount\":100,\"sold_qty\":6,\"product_url\":\"aweme://poi/goodsdetail/?hide_own_nav_bar=1\\u0026activity_id=1792588596209674\\u0026enter_from=local_life_im\\u0026detail_enter_page=local_life_im\\u0026is_life_poi=1\\u0026detail_enter_method=card\",\"image_uri\":\"tos-cn-i-hf2m9xxmck/c72a14d204bc4a47b91bc5c62304aff6\",\"pc_product_url\":\"\",\"origin_amount\":1500}", "user_infos": [{ "open_id": "9d3b4506-7294-5d2f-aee6-9cf5ace3aa73", "nick_name": "蓝v婚庆113", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "b9b71865-7fea-44cc-8636-727e89f72be9", "nick_name": "at2201", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502400810000 }
系统提示	-	notice	否		{ "conversation_short_id": "@9VwIwfmRWdMjN3X3ZYsqVc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBRiZ5AfXYWc7bz99LFISPpQ==", "server_message_id": "@9VwIwfmRWdMjN3X3ZYsqVc790GDoPvCEPpdyoAmiLFUXafP/60zdRmYqig357zEBRa5mCKbBH8coTKGmZKJ++A==", "conversation_type": 1, "create_time": 1758194191506, "message_type": "notice", "source": "", "im_mode": "Unset", //type Notice struct { // // 内容 // Tips string `json:"tips,omitempty"` // // 通知详情 // PushDetail string `json:"push_detail,omitempty"` //} "notice": "{\"tips\":\"回复超时，智能客服介入接待（您可以在“人工客服设置-接待不及时设置”中调整配置） {{1}}\",\"push_detail\":\"\"}", "user_infos": [{ "open_id": "9d3b4506-7294-5d2f-aee6-9cf5ace3aa73", "nick_name": "蓝v婚庆113", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "b9b71865-7fea-44cc-8636-727e89f72be9", "nick_name": "at2201", "avatar": "https://p11.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502400750000 }
问题列表	-	question_list	否		{ "conversation_short_id": "@9VwIwfmRWdMjN3X3ZYsqVc791mzgO/mKM5xwrQmjL1AVafT460zdRmYqig357zEBRiZ5AfXYWc7bz99LFISPpQ==", "server_message_id": "@9VwIwfmRWdMjN3X3ZYsqVc790GDoPvCEPpZ2qwmvKlARaPL160zdRmYqig357zEBTLO2+Id3h22GEtDgzAsOtQ==", "conversation_type": 1, "create_time": 1758194195199, "message_type": "question_list", "source": "", "im_mode": "Unset", //type QuestionList struct { // // 标题 // Title *string `json:"title,omitempty"` // // 问题 // Questions []string `json:"questions,omitempty"` //} "question_list": "{\"title\":\"好的亲，请问您家房子是在【哪个城市】呢？给您安排附近门店。\",\"questions\":[\"北京\",\"上海\",\"深圳\",\"广州\",\"杭州\",\"南京\",\"成都\",\"其他城市\"]}", "user_infos": [{ "open_id": "9d3b4506-7294-5d2f-aee6-9cf5ace3aa73", "nick_name": "蓝v婚庆113", "avatar": "https://p26.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "b9b71865-7fea-44cc-8636-727e89f72be9", "nick_name": "at2201", "avatar": "https://p26.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502400770000 }
企业微信卡	-	enterprise_wechat_card	否		{ "conversation_short_id": "@9VwIwfmRWdMjN3X3ZYsqVc790WbtOf2KP5B1qAqhJlAXafb160zdRmYqig357zEBKEl8QmyYXAVwecSjKkRWPQ==", "server_message_id": "@9VwIwfmRWdMjN3X3ZYsqVc7902frNfCKMpR4qQqmLVIUaPH560zdRmYqig357zEBKTWcn+lDsk6by5mv/nS+SQ==", "conversation_type": 1, "create_time": 1774842138939, "message_type": "enterprise_wechat_card", "source": "", "im_mode": "Unset", //type WechatCACardCommonContent struct { // Type string `json:"type"` // EnterpriseName string `json:"enterprise_name"` // CompanyName string `json:"company_name"` // Tag string `json:"tag"` // ButtonText string `json:"button_text"` //} "common_content": "{\"type\":\"wechat_ca_card\",\"enterprise_name\":\"蓝v婚庆113\",\"company_name\":\"企业号经营\",\"tag\":\"提供专属优质服务\",\"button_text\":\"添加企业微信\"}", "user_infos": [{ "open_id": "9d3b4506-7294-5d2f-aee6-9cf5ace3aa73", "nick_name": "蓝v婚庆113", "avatar": "https://p26.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813c001_oQAAAr7YXqzIfCrA4ABF1EarNjvei9igAj2AKS.jpeg?from=3782654143" }, { "open_id": "b9b71865-7fea-44cc-8636-727e89f72be9", "nick_name": "at2201", "avatar": "https://p26.douyinpic.com/aweme/720x720/aweme-avatar/douyin-user-image-file_86e8d1ef074079d967ae2833e0d8772e.jpeg?from=3782654143" }], "group_info": {}, "index": 1672502433310000 }

2.2 查询咨询卡片列表

能力说明

支持查询客户已创建的咨询卡片，包含电话收集，文字链接两种类型的卡片

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_card/
http method	post
scope	ad.ledas.im_component_query

接口入参

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
card_type	int32	是	卡片类型：1-文字链接；5-电话收集
status	int32	否	卡片状态，不传代表查所有状态 0：审核中 1：生效 2：审核失败
ids	list<int64>	否	卡片id，不传则查所有
page	int32	是	分页查询的页数，从1开始
page_size	int32	是	单页查询个数，最多50

接口返回值

字段名称	字段类型	含义说明
data	QueryCardPageStruct	返回内容结构见：QueryCardPageStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

QueryCardPageStruct结构

字段名称	字段类型	含义说明
total	int32	总数量，最多支持查询100个数据
cards	list<MessageCardStruct>	卡片列表结构见：MessageCardStruct

MessageCardStruct结构

字段名称	字段类型	含义说明
id	int64	卡片id
card_type	int32	卡片类型:1- 文字链接；5-电话收集
name	string	卡片名称
content	string	卡片内容
status	int32	卡片状态
status_msg	int32	审核状态信息
action	list<MessageCardActionStruct>	卡片跳转配置，仅文字链接类型的卡片有，电话收集卡片该字段没有值结构见：MessageCardActionStruct

MessageCardActionStruct结构

字段名称	字段类型	含义说明
name	string	跳转链接名称
action_type	int32	动作类型：2-跳转
im_component	ImComponent	组件信息结构见：ImComponent

ImComponent结构

字段名称	字段类型	含义说明
type	string	组件类型：industry_advanced_online_reserve-高级在线预约
component_id	int64	组件id
component_name	string	组件名称
extra	string	其他扩展字段

错误码

http状态	错误码	错误描述	处理方式
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常
200	28001011	无权限	暂不支持访问

2.3 查询高级在线预约卡片列表

权限校验

仅限线索抖音号调用

能力说明

支持查询在线索经营平台创建的高级在线预约组件

接口详情

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_marketing_tool/
http method	post
scope	ad.ledas.im_component_query

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
page	int32	是	分页查询的页数，从1开始
page_size	int32	是	单页查询个数，最多50
link_types	list<int32>	是	组件类型 45-高级在线预约，当前仅支持查询高级在线预约

接口返回值

字段名称	字段类型	含义说明
data	MarketingToolInfoStruct	返回内容结构见：MarketingToolInfoStruct
err_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

MarketingToolInfoStruct结构

字段名称	字段类型	含义说明
tools	list<MarketingToolInfo>	组件列表结构见：MarketingToolInfo
total	int32	总数量

MarketingToolInfo 结构

字段名称	字段类型	含义说明
title_image	string	头图
create_time	int64	创建时间，单位：秒
component_id	int64	组件id
title	string	标题
sub_title	string	子标题

错误码

http状态	错误码	错误描述	处理方式
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常
200	28001011	无权限	暂不支持访问

2.4 查询线索商品列表

能力说明

支持查询在来客平台关联的线索商品，需要接入「生活服务商家应用」 先关联商品后才可查询，技术服务商接入指南_生活服务商家应用_抖音开放平台

权限校验

仅限线索抖音号+开通生服线索经营业务调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im_life/list_life_leads_tool/
http method	post
scope	life.capacity.leads.clue_product.query

接口入参

字段名称	字段类型	是否必填	含义说明
Page	int32	是	分页查询的页数，从1开始
PageSize	int32	是	单页查询个数，最多50
account_id	string	是	生服账户id
client_key	string	是

接口返回值

字段名称	字段类型	含义说明
data	LifeLeadsToolsStruct	返回内容结构见：LifeLeadsToolStruct
extra	ExtraBody	其他信息

Extrabody

字段名称	字段类型	含义说明
log_id	string	链路id
now	int64	时间
error_code	int32	错误码
description	string	错误描述

LifeLeadsToolStruct结构

字段名称	字段类型	含义说明
tools	list<LifeLeadsTool>	线索商品列表结构见：LifeLeadsTool
total	int32	总数量，最多支持查询100个数据

LifeLeadsTool结构

字段名称	字段类型	含义说明
id	string	组件id
title	string	商品名称
image_url	string	图片
create_time	int64	创建时间，单位：秒
product_id	int64	线索商品id/线索组件id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.5 查询招商加盟落地页列表

能力说明

支持查询在来客平台创建的招商加盟落地页，需接入「生活服务商家应用」，技术服务商接入指南_生活服务商家应用_抖音开放平台

权限校验

仅限线索抖音号+开通生服线索经营业务+生服招商加盟商家调用

接口详情

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im_life/list_life_landing_page/
http method	post
scope	life.capacity.leads.landing_page.query

接口入参

字段名称	字段类型	是否必填	含义说明
page	int32	是	分页查询的页数，从1开始
page_size	int32	是	单页查询个数，最多20
landing_page_type	int32	是	1-招商加盟落地页
account_id	string	是	生服账户id
client_key	string	是

接口返回值

字段名称	字段类型	含义说明
data	LifeLandingPage	返回内容结构见：LifeLandingPage
extra	ExtraBody	其他信息，包括错误信息

Extrabody

字段名称	字段类型	含义说明
log_id	string	链路id
now	int64	时间
error_code	int32	错误码
description	string	错误描述

LifeLandingPage结构

字段名称	字段类型	含义说明
tools	list<LifeLandingPage>	招商加盟落地页列表结构见：LifeLandingPage
total	int32	总数量

LifeLandingPage结构

字段名称	字段类型	含义说明
id	int64	组件id
title	string	招商加盟落地页名称
image_url	string	图片
create_time	int64	创建时间，单位：秒
product_id	string	招商加盟商品id/线索组件id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.6 查询poi卡片列表

权限校验

仅限线索抖音号+开通生服线索经营业务调用，需接入「生活服务商家应用」，技术服务商接入指南_生活服务商家应用_抖音开放平台

能力说明

支持查询在来客平台创建的poi卡片

接口详情

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im_life/list_life_poi/
http method	post
scope	life.capacity.leads.poi.query

接口入参

字段名称	字段类型	是否必填	含义说明
page	int32	是	分页查询的页数，从1开始
page_size	int32	是	单页查询个数，最多50
account_id	string	是	生服账户id
client_key	string	是

接口返回值

字段名称	字段类型	含义说明
data	LifeLeadsPoiStruct	返回内容结构见：LifeLeadsPoiStruct
extra	Extrabody	其他信息

Extrabody

字段名称	字段类型	含义说明
log_id	string	链路id
now	int64	时间
error_code	int32	错误码
description	string	错误描述

LifeLeadsPoiStruct结构

字段名称	字段类型	含义说明
tools	list<LifePoi>	poi列表结构见：LifePoi
total	int32	总数量

LifePoi结构

字段名称	字段类型	含义说明
id	int64	poiId
title	string	门店名称
image_url	string	图片
main_category	list<string>	主营类目
address	string	地址

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.7 自定义「一键收集电话」的文案

能力说明

支持客户自定义一键收集电话组件的文案，具体

权限校验

仅限线索抖音号调用

2.8 保存/编辑[一键收集电话]的文案

能力说明

支持客户创建[一键收集电话]的文案

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/save_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	否	一键收集电话组件的自定义文案类型：新增无需传入，修改传入相应快捷组件组件ID。
rule_name	int32	是	一键收集电话组件的自定义文案-标题
content	ReplyContent	是	一键收集电话组件的自定义文案-内容（300字内）（详细字段见结构体：ReplyContent）
extra	string（json字符串）	是	附加参数：一键收集电话组件自定义文案key为：leads_card_text value：true

接口返回值：

字段名称	字段类型	含义说明
data	SaveQuickStruct	返回内容结构见：SaveQuickStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

ReplyContent结构

字段名称	字段类型	是否必填	含义说明
type	int32	是	一键收集电话组件的自定义文案内容类型必须为：1-文本
text	ReplyContentText	否	一键收集电话组件文本内容

SaveQuickStruct结构

字段名称	字段类型	是否必填	含义说明
id	int32	是	一键收集电话组件

ReplyContentText结构

字段名称	字段类型	是否必填	含义说明
text	string	是	一键收集电话组件的自定义文案内容

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.9 查询[一键收集电话]文案

能力说明

支持客户查询一键收集电话组件的自定义文案

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_extra_type	int32	是	1-一键收集电话组件

接口返回值：

字段名称	字段类型	是否必填	含义说明
data	GetAllQuickStruct	是	返回内容结构见：GetAllQuickStruct
erro_no	int32	是	错误code码
err_msg	string	是	错误说明
log_id	string	是	调用链路id

GetAllQuickStruct结构

字段名称	字段类型	含义说明
quick_reply_list	list<QuickReply>	返回一键收集电话组件的自定义文案内容结构见：QuickReply

QuickReply结构

字段名称	字段类型	是否必填	含义说明
reply_id	string	是	一键收集电话组件的自定义文案Id
rule_name	string	是	一键收集电话组件的自定义文案-标题
content	ReplyContent	是	一键收集电话组件的自定义文案内容 ReplyContent 结构体如上
reply_desc	string	否	回复描述，仅用于B端列表展示
extra	string	否	一键收集电话组件的自定义文案扩展值

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.10 删除[一键收集电话]文案

能力说明

支持客户删除已经创建的一键收集电话自定义文案

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/del_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	是	一键收集电话自定义文案Id

接口返回值：

字段名称	字段类型	是否必填	含义说明
erro_no	int32	是	错误code码
err_msg	string	是	错误说明
log_id	string	是	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.11 保存/编辑快捷回复

能力说明

支持客户创建快捷回复，包含文字链接、消息卡片两种类型的快捷回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/save_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	否	快捷回复ID：新增无需传入，修改传入相应快捷回复组件ID。
rule_name	int32	是	快捷回复-标题
content	ReplyContent	否	快捷回复-内容（详细字段见结构体：ReplyContent）
extra	string（json字符串）	否	附加参数：留资卡自定义文案key为：leads_card_text，value：为具体文案

接口返回值：

字段名称	字段类型	含义说明
data	SaveQuickStruct	返回内容结构见：SaveQuickStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

ReplyContent结构

字段名称	字段类型	是否必填	含义说明
type	int32	是	快捷回复内容类型，1-文本，5-消息卡片
text	ReplyContentText	否	文本内容-类型为文本时必填结构见：ReplyContentText
cards	ReplyContentCard	否	文本内容-类型为文本时必填结构见：ReplyContentCard
abnormal_reason	string	否	快捷回复内容仅在查询接口中返回，用于页面渲染

SaveQuickStruct结构

字段名称	字段类型	是否必填	含义说明
id	int32	是	快捷回复id

ReplyContentText结构

字段名称	字段类型	是否必填	含义说明
text	string	是	快捷回复-文本内容

ReplyContentCard结构

字段名称	字段类型	是否必填	含义说明
card_id	int64	是	快捷回复-消息卡片Id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.12 查询快捷回复列表

能力说明

支持客户查询快捷回复列表，包含文字链接、消息卡片两种类型的快捷回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_extra_type	int32	是	0-快捷回复组件（包括一键收集电话组件），1-一键收集电话组件

接口返回值：

字段名称	字段类型	是否必填	含义说明
data	GetAllQuickStruct	是	返回内容结构见：GetAllQuickStruct
erro_no	int32	是	错误code码
err_msg	string	是	错误说明
log_id	string	是	调用链路id

GetAllQuickStruct结构

字段名称	字段类型	含义说明
quick_reply_list	list<QuickReply>	返回快捷回复内容结构见：QuickReply

QuickReply结构

字段名称	字段类型	是否必填	含义说明
reply_id	string	是	快捷回复Id
rule_name	string	是	快捷回复-标题
content	ReplyContent	是	快捷回复内容 ReplyContent 结构体如上
reply_desc	string	否	回复描述，仅用于B端列表展示
extra	string	否	快捷回复扩展值

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.13 删除快捷回复

能力说明

支持客户删除已经创建的快捷回复，包含文字链接、消息卡片两种类型的快捷回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/del_quick_reply/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	是	快捷回复Id

接口返回值：

字段名称	字段类型	是否必填	含义说明
erro_no	int32	是	错误code码
err_msg	string	是	错误说明
log_id	string	是	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.14 保存/编辑自动回复

能力说明

支持客户创建自动回复，包含进入对话、关键词回复两种类型的自动回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/save_auto_reply/
http method	post
scope	ad.leads.im_component_manage_auto_reply

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	否	自动回复ID：新增无需传入，修改传入相应自动回复组件ID。
rule_type	int32	是	自动回复类型：1-进入对话（欢迎语），2-关键词回复
rule_conf	RuleConf	否	自动回复-关键词结构体（详细字段参考下方结构体RuleConf）
reply_content	ReplyContent	是	自动回复-内容（详细字段见下方结构体：ReplyContent）

接口返回值：

字段名称	字段类型	含义说明
data	SaveAutoRely	返回内容结构见：SaveAutoRely
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

ReplyContent结构

字段名称	字段类型	是否必填	含义说明	截图案例	请求体案例
type	int32	是	自动回复内容类型，1-文本，5-消息卡片，12-问题列表，26一键留资，7-经营工具
text	ReplyContentText	否	文本内容-类型为文本时必填结构见：ReplyContentText		`{"reply_content":{"type":1,"text":{"text":"测试欢迎语纯文本。"}}}`
cards	ReplyContentCard	否	消息卡片内容-类型为卡片时必填结构见：ReplyContentCard		`{"reply_content":{"type":5,"card":{"card_id":887873},"after":{"type":1,"text":{"text":"测试欢迎语一键留资"}}}}`
component	ComponentRel	否	工具内容：经营工具/交易工具结构见：ComponentRel		`{"reply_content":{"type":7,"component":{"component_type":"industry_advanced_online_reserve","component_id":"7376837095047908133","component_name":"看房服务","extra":"{\"create_time\":1717556522,\"cover_url\":\"https://p3-saiyan-sign.byteimg.com/aweme-saiyan-private/cpft9hrc77u6kb0sovhg~tplv-k9qcquo31z-2000.image?lk3s=e44e97a5&x-expires=1735733242&x-signature=nI1emmUqeBy%2By7M2MMTq5QsdvQM%3D\"}"},"after":{"type":1,"text":{"text":"测试欢迎语经营工具。"}}}}`
questions	ReplyContentQuestions	否	问题列表内容：结构见ReplyContentQuestions		{"reply_content":{"type":12,"questions":{"reply_list":[{"reply_content":{"type":1,"text":{"text":"士大夫"}},"rule_conf":{"match_pattern":2,"keyword":"士大夫萨芬萨芬"},"rule_type":2,"reply_id":"","uniqueId":"6802f054-37be-4460-8117-954863ab6e7d"},{"reply_content":{"type":1,"text":{"text":"算法"}},"rule_conf":{"match_pattern":2,"keyword":"水岸东方艾师傅萨芬"},"rule_type":2,"reply_id":"","uniqueId":"91f6058e-725a-4261-ad25-8dc43f0bdb96"}]},"after":{"type":1,"text":{"text":"1223测试欢迎语编辑过一次士大夫，，"}}}}
before	ReplyContent	否	一般为空
after	ReplyContent	否	注意：自动回复类型为问题列表、消息卡片、一键留资、经营/交易工具时，此字段内容需要存欢迎语文本，参考请求体案例。		一键留资卡案例 `{"reply_content":{"type":26,"after":{"type":1,"text":{"text":"测试欢迎语一键留资"}}}}`

RuleConf结构

字段名称	字段类型	是否必填	含义说明
rule_name	string	是	关键词规则名
key_word	string	是	关键词
match_pattern		是	是否完全匹配。1-非完全匹配。2-完全匹配

SaveAutoRely结构

字段名称	字段类型	是否必填	含义说明
reply_id	int32	是	自动回复id

ReplyContentText结构

字段名称	字段类型	是否必填	含义说明
text	string	是	自动回复-文本内容

ReplyContentCard结构

字段名称	字段类型	是否必填	含义说明
card_id	int64	是	自动回复-消息卡片Id

ComponentRel结构

字段名称	字段类型	是否必填	含义说明
component_type	string	是	工具类型。如：industry_advanced_online_reserve
component_id	string	是	工具ID
component_name	string	是	工具名称
extra	string	是	工具组件json字符串

ReplyContentQuestions结构

字段名称	字段类型	是否必填	含义说明
reply_list	list<AutoReply>	是	自动回复-问题列表内容

AutoReply结构

字段名称	字段类型	是否必填	含义说明
reply_id	string	否	回复ID,新增时无需传入
rule_type	int32	是	问题列表时传入2
rule_conf	RuleConf	否	问题列表内容结构
reply_content	ReplyContent		问题列表问题答案

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.15 删除自动回复

能力说明

支持客户删除自动回复，包含欢迎语、关键词两种类型的快捷回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/del_quick_reply/
http method	post
scope	ad.leads.im_component_manage_auto_reply

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	否	自动回复组件ID。

接口返回值：

字段名称	字段类型	含义说明
data	SaveAutoRely	返回内容结构见：SaveAutoRely
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

SaveAutoRely结构

字段名称	字段类型	是否必填	含义说明
id	int32	是	自动回复id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.16 查询自动回复列表

能力说明

支持客户查询自动回复，包含欢迎语、关键词两种类型的自动回复列表

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_auto_reply/
http method	post
scope	ad.leads.im_component_manage_auto_reply

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_type	int32	否	自动回复类型：1-进入对话（欢迎语），2-关键词回复
status	int32	是	自动回复-状态：0-审核中，-1-已删除，1-有效，2-审核失败
page	int32	否	分页参数，起始页，大于0
page_size	int32	否	分页参数，页大小，大于0小于200

接口返回值：

字段名称	字段类型	含义说明
data	ListAutoReplyStruct	返回内容结构见：ListAutoReplyStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

ListAutoReplyStruct结构

字段名称	字段类型	是否必填	含义说明
reply_list	list<AutoReply>	是	自动回复结构体明细，AutoReply参考下方
total_num	i64	是	自动回复的条数

AutoReply结构

字段名称	字段类型	是否必填	含义说明
reply_id	string	是	自动回复ID
rule_type	int32	是	自动回复类型
rule_conf	RuleConf	否	自动回复关键词规则结构体，字段参考上方RuleConf
reply_content	ReplyContent	是	自动回复结构体，字段参考上方ReplyContent
status	int32	是	自动回复-状态：0-审核中，-1-已删除，1-有效，2-审核失败
audit_reason	string	否	自动回复审核失败原因

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.17 查询单个自动回复

能力说明

支持客户查询单个自动回复，包含欢迎语、自动回复两种类型的自动回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/get_setting/
http method	post
scope	ad.leads.im_component_manage_auto_reply

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
reply_id	string	否	快捷回复类型：新增无需传入，修改传入相应快捷组件组件ID。

接口返回值：

字段名称	字段类型	含义说明
data	AutoReplySturct	返回内容结构见：AutoReplySturct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

AutoReplySturct结构

字段名称	字段类型	是否必填	含义说明
reply	AutoReply	是	自动回复内容，结构体参考上方AutoReply

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.18 查询自动回复开关

能力说明

支持客户查询自动回复开关，包含欢迎语、关键词回复类型的自动回复开关

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/get_setting/
http method	post
scope	ad.leads.im_component_manage_one_click_phone_colle

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识

接口返回值：

字段名称	字段类型	含义说明
data	GetAutoSettingStruct	返回内容结构见：GetAutoSettingStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetAutoSettingStruct结构

字段名称	字段类型	是否必填	含义说明
switch_config	list<RuleSwitch>	是	自动回复开关,字段见RuleSwitch结构体
max_count	int32	否	用户可配置自动回复最大数量
over_limit_text	string	否	超出配置上限提示
guide_window	window	否	快捷回复内容仅在查询接口中返回，用于页面渲染

RuleSwitch结构

字段名称	字段类型	是否必填	含义说明
rule_type	int32	是	自动回复类型，1-欢迎语，2-关键词回复，11-自动引导留资
status	int32	是	开关状态，0-关闭，1-打开

window结构

字段名称	字段类型	是否必填	含义说明
text	string	否	自动回复-文本内容
jump_url	string	否	自动回复跳转链接

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.19 更新自动回复开关

能力说明

支持客户更新自动回复，包含欢迎语、关键词两种类型的快捷回复

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_setting/
http method	post
scope	ad.leads.im_component_manage_auto_reply

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	调用/oauth/access_token/生成的token，此token需要经营者授权，用户唯一标识
switch_config	list<RuleSwitch>	是	开关信息，字段参考上方RuleSwitch结构体

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.20 查看快捷引导配置

能力说明

支持客户查看已配置的快捷引导

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_actionbar/
http method	post
scope	ad.leads.im_manage_actionbar

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id

接口返回值：

字段名称	字段类型	含义说明
data	GetAllGuestActionBarStruct	快捷回复配置数据，结构见：GetAllGuestActionBarStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetAllGuestActionBarStruct

字段名称	字段类型	含义说明
guest_actionbar_list	list<GuestActionBar>	快捷回复配置列表，结构见：GuestActionBar
switch_state	bool	整体开关开启状态，true-打开，false-关闭

GuestActionBar

字段名称	字段类型	含义说明
uniq_id	string	快捷回复配置唯一id
name	string	入口名称
text	string	点击后发送内容
status	int32	DELETED = -1 删除 AUDITING = 0 审核中 VALID = 1 生效（审核通过） AUDIT_FAILED = 2 审核失败 SYSTEM_DEFAULT = 3 系统默认
audit_fail_reason	string	审核失败原因
close	bool	配置开关是否关闭
type	int32	0：用户发问引导 1：立即预约，暂不支持修改立即预约配置，无法被删除，仅支持操作开关

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.21 使用默认快捷引导配置

能力说明

支持客户更新已配置的快捷引导为默认的配置

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/default_actionbar/
http method	post
scope	ad.leads.im_manage_actionbar

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id

接口返回值：

字段名称	字段类型	含义说明
data	GetAllGuestActionBarStruct	快捷回复配置数据，结构见：GetAllGuestActionBarStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetAllGuestActionBarStruct

字段名称	字段类型	含义说明
guest_actionbar_list	list<GuestActionBar>	快捷回复配置列表，结构见：GuestActionBar
switch_state	bool	整体开关开启状态，true-打开，false-关闭

GuestActionBar

字段名称	字段类型	含义说明
uniq_id	string	快捷回复配置唯一id
name	string	入口名称
text	string	点击后发送内容
status	int32	DELETED = -1 删除 AUDITING = 0 审核中 VALID = 1 生效（审核通过） AUDIT_FAILED = 2 审核失败 SYSTEM_DEFAULT = 3 系统默认
audit_fail_reason	string	审核失败原因
close	bool	配置开关是否关闭
type	int32	0：用户发问引导 1：立即预约，暂不支持修改立即预约配置

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.22 一键关闭快捷引导配置

能力说明

一键关闭所有快捷引导配置的开关

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/switch_actionbar/
http method	post
scope	ad.leads.im_manage_actionbar

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
switch_state	bool	是	是否打开开关：false-关闭，暂不支持一键全部打开

接口返回值：

字段名称	字段类型	含义说明
data	GetAllGuestActionBarStruct	快捷回复配置数据，结构见：GetAllGuestActionBarStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetAllGuestActionBarStruct

字段名称	字段类型	含义说明
guest_actionbar_list	list<GuestActionBar>	快捷回复配置列表，结构见：GuestActionBar
switch_state	bool	整体开关开启状态，true-打开，false-关闭

GuestActionBar

字段名称	字段类型	含义说明
uniq_id	string	快捷回复配置唯一id
name	string	入口名称
text	string	点击后发送内容
status	int32	DELETED = -1 删除 AUDITING = 0 审核中 VALID = 1 生效（审核通过） AUDIT_FAILED = 2 审核失败 SYSTEM_DEFAULT = 3 系统默认
audit_fail_reason	string	审核失败原因
close	bool	配置开关是否关闭
type	int32	0：用户发问引导 1：立即预约，暂不支持修改立即预约配置

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.23 修改快捷引导配置

能力说明

修改快捷引导配置

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/modify_actionbar/
http method	post
scope	ad.leads.im_manage_actionbar

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
guest_actionbar_list	list<GuestActionBar>	是	快捷回复配置列表，暂不支持删除立即预约配置

GuestActionBar

字段名称	字段类型	含义说明
uniq_id	string	快捷回复配置唯一id
name	string	入口名称
text	string	点击后发送内容
status	int32	DELETED = -1 删除 AUDITING = 0 审核中 VALID = 1 生效（审核通过） AUDIT_FAILED = 2 审核失败 SYSTEM_DEFAULT = 3 系统默认
audit_fail_reason	string	原始审核失败原因
close	bool	配置开关是否关闭
type	int32	0：用户发问引导 1：立即预约，暂不支持修改立即预约配置

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.24 查看自动引导留资配置

能力说明

支持客户查看自动引导留资配置

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_task_flow/
http method	post
scope	ad.leads.im_manage_taskflow

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id

接口返回值：

字段名称	字段类型	含义说明
data	ListTaskFlowData	自动引导留资配置数据，结构见：ListTaskFlowData
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

ListTaskFlowData

字段名称	字段类型	含义说明
actions	list<TaskflowAction>	配置列表，结构见：TaskflowAction
default_actions	list<TaskflowAction>	行业默认列表，结构见：TaskflowAction

TaskflowAction

字段名称	字段类型	含义说明
id	int64	话术唯一id
seq	i64	问题序号，用户编辑使用，关联前后节点
question	string	引导发问内容
status	int32	审核状态 0未知 1已生效 2已删除 3审核中 4审核失败
item_type	int32	附加内容：0-无；1-问题列表；2-一键留资
action_type	int32	话术类型：0-普通话术；1-开场白；2-结束语
audit_reason	string	审核失败原因
options	list<TaskflowActionOption>	选项和对应指向的序号

TaskflowActionOption

字段名称	字段类型	含义说明
content	string	内容
go_to_seq	int64	指向的序号

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.25 更新自动引导留资配置

能力说明

支持客户更新自动引导留资配置

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/save_task_flow_action/
http method	post
scope	ad.leads.im_manage_taskflow

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
actions	list<TaskflowAction>	是	配置列表

TaskflowAction

字段名称	字段类型	含义说明
id	int64	话术唯一id
seq	i64	问题序号，用户编辑使用，关联前后节点
question	string	引导发问内容
item_type	int32	附加内容：0-无；1-问题列表；2-一键留资
action_type	int32	话术类型：0-普通话术；1-开场白；2-结束语
options	list<TaskflowActionOption>	选项和对应指向的序号

TaskflowActionOption

字段名称	字段类型	含义说明
content	string	内容
go_to_seq	int64	指向的序号

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.26 新增用户触达计划

能力说明

支持客户新增用户触达计划，新增计划审核通过后，历史生效中的计划会自动关闭

触达拦截规则：

https://leads.cluerich.com/help-center/content/132755

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/upsert_marketing/
http method	post
scope	ad.leads.im_manage_marketing

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
plan	MarketingPlan	是	触达计划配置

MarketingPlan

字段名称	字段类型	含义说明
name	string	计划名称
plan_type	int32	计划类型: 0 短视频高意向评论用户跟进 3 直播高意向弹幕用户跟进
crowd_type	int32	目标人群:Default = 0 默认,由PlanType确定人群
trigger_event	int32	触发事件:Default = 0 默认，由PlanType确定触发事件
content	MarketingReplyContent	内容，见结构：MarketingReplyContent

MarketingReplyContent

字段名称	字段类型	含义说明
type	int32	文本 = 1 组件 = 7
text	MarketingReplyContentText	文本，结构见：MarketingReplyContentText
component	MarketingImComponent	高级在线预约，结构见：MarketingImComponent
before	MarketingReplyContent	在type内容之前触发，结构见：MarketingReplyContent
after	MarketingReplyContent	在type内容之后触发，结构见：MarketingReplyContent

MarketingReplyContentText

字段名称	字段类型	含义说明
text	string	文本内容

MarketingImComponent

字段名称	字段类型	含义说明
type	string	组件类型，高级在线预约-industry_advanced_online_reserve
component_id	string	组件id
component_name	string	组件名称

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

示例

创建类型	入参示例
短视频用户高意向评论，无附加内容	`{ "content": { "type": 1, "text": { "text": "您好，看到您在评论区咨询，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈！" } }, "name": "高意向评论用户触达计划", "crowdType": 0, "planType": 0, "triggerEvent": 0 }`
短视频用户高意向评论，附加一键留资卡	`{ "content": { "type": 2, "text": { "text": "您好，看到您在评论区咨询，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈！" } }, "name": "高意向评论用户触达计划", "crowdType": 0, "planType": 0, "triggerEvent": 0 }`
短视频用户高意向评论，附加高级在线预约卡片	{ "content": { "type": 7, "component": { "component_id": "7441118309736614707", //组件id "component_type": "industry_advanced_online_reserve", //组件类型 "component_name": "AC Cobra GT Roadster", //组件名称 "extra": "", "link": "" }, "before": { "type": 1, "text": { "text": "您好，看到您在评论区咨询，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈！" } } }, "name": "高意向评论用户触达计划", "crowdType": 0, "planType": 0, "triggerEvent": 0 }
直播间高意向弹幕，无附加内容	`{ "content": { "type": 1, "text": { "text": "您好，看到您在直播间发了弹幕，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈" } }, "name": "高意向直播间弹幕触达计划", "crowdType": 0, "planType": 3, "triggerEvent": 0 }`
直播间高意向弹幕，附加一键留资卡	`{ "content": { "type": 2, "text": { "text": "您好，看到您在直播间发了弹幕，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈" } }, "name": "高意向直播间弹幕触达计划", "crowdType": 0, "planType": 3, "triggerEvent": 0 }`
直播间高意向弹幕，附加高级在线预约	{ "content": { "type": 7, "component": { "component_id": "7441118309736614707", "component_type": "industry_advanced_online_reserve", "component_name": "AC Cobra GT Roadster", "extra": "", "link": "" }, "before": { "type": 1, "text": { "text": "您好，看到您在直播间发了弹幕，如果您有拍套照片的想法，您留个联系方式，咱们顾问给您详细介绍拍摄套餐哈" } } }, "name": "高意向直播间弹幕触达计划", "crowdType": 0, "planType": 3, "triggerEvent": 0 }

2.27 查询用户触达计划详情

能力说明

支持客户查询用户触达计划

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/get_marketing/
http method	post
scope	ad.leads.im_manage_marketing

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
id	int64	是	触达计划id

接口返回值：

字段名称	字段类型	含义说明
data	GetMarketingPlanDetailStruct	结构见：GetMarketingPlanDetailStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetMarketingPlanDetailStruct

字段名称	字段类型	含义说明
plan	MarketingPlan	计划详情，结构见：MarketingPlan

MarketingPlan

字段名称	字段类型	含义说明
id	int64	计划id
name	string	计划名称
plan_type	int32	计划类型: 0 短视频高意向评论用户跟进 3 直播高意向弹幕用户跟进
crowd_type	int32	目标人群:Default = 0 默认,由PlanType确定人群
trigger_event	int32	触发事件:Default = 0 默认，由PlanType确定触发事件
content	MarketingReplyContent	内容，见结构：MarketingReplyContent
status	int32	计划状态 0-草稿 1-审核中 2-审核失败 3-审核成功 4-发送中 5-发送失败 6-发送成功 7-执行中 8-已暂停 9-已删除
task_id	string	群发和订阅任务id
send_cnt	string	触达人数
clue_cnt	string	留资人数
trigger_event_str	string	触发方式显示文本
send_time_str	string	发送时机显示文本
notify_type	int32	触达类型:Default = 0 // 默认由PlanType确定触发类型
notify_type_str	string	触达类型显示文本
status_fail_tip	string	失败状态提示文案
send_crowd_str	string	发送人群显示文本
clue_rate	string	留资率
start_time	int64	开始触达时间，毫秒
end_time	int64	结束触达时间，毫秒

MarketingReplyContent

字段名称	字段类型	含义说明
type	int32	文本 = 1 组件 = 7
text	MarketingReplyContentText	文本，结构见：MarketingReplyContentText
component	MarketingImComponent	高级在线预约，结构见：MarketingImComponent
before	MarketingReplyContent	在type内容之前触发，结构见：MarketingReplyContent
after	MarketingReplyContent	在type内容之后触发，结构见：MarketingReplyContent

MarketingReplyContentText

字段名称	字段类型	含义说明
text	string	文本内容

MarketingImComponent

字段名称	字段类型	含义说明
type	string	组件类型，高级在线预约-industry_advanced_online_reserve
component_id	string	组件id
component_name	string	组件名称

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.28 查询用户触达计划列表

能力说明

支持客户查询用户触达计划列表

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/list_marketing/
http method	post
scope	ad.leads.im_manage_marketing

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
page	int32	是	页码，从1开始
page_size	int32	是	单页数量，最多50
name	string	否	触达计划名称
plan_type	int32	否	计划类型：0-短视频高意向评论用户跟进；3-直播高意向弹幕用户跟进
status_list	list<int32>	否	计划状态 0-草稿 1-审核中 2-审核失败 3-审核成功 4-发送中 5-发送失败 6-发送成功 7-执行中 8-已暂停 9-已删除
with_deleted_plan	bool	否	是否查询已删除加护
plan_type_list	list<int32>	否	PTVideoComment = 0 短视频高意向评论用户跟进 PTLiveComment = 3 直播高意向弹幕用户跟进

接口返回值：

字段名称	字段类型	含义说明
data	GetMarketingPlanListStruct	结构见：GetMarketingPlanListStruct
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

GetMarketingPlanListStruct

字段名称	字段类型	含义说明
marketing_plan_list	list<MarketingPlan>	计划详情，结构见：MarketingPlan
total_num	int32	总数量

MarketingPlan

字段名称	字段类型	含义说明
id	int64	计划id
name	string	计划名称
plan_type	int32	计划类型: 0 短视频高意向评论用户跟进 3 直播高意向弹幕用户跟进
crowd_type	int32	目标人群:Default = 0 默认,由PlanType确定人群
trigger_event	int32	触发事件:Default = 0 默认，由PlanType确定触发事件
content	MarketingReplyContent	内容，见结构：MarketingReplyContent
status	int32	计划状态 0-草稿 1-审核中 2-审核失败 3-审核成功 4-发送中 5-发送失败 6-发送成功 7-执行中 8-已暂停 9-已删除
task_id	string	群发和订阅任务id
send_cnt	string	触达人数
clue_cnt	string	留资人数
trigger_event_str	string	触发方式显示文本
send_time_str	string	发送时机显示文本
notify_type	int32	触达类型:Default = 0 // 默认由PlanType确定触发类型
notify_type_str	string	触达类型显示文本
status_fail_tip	string	失败状态提示文案
send_crowd_str	string	发送人群显示文本
clue_rate	string	留资率
start_time	int64	开始触达时间，毫秒
end_time	int64	结束触达时间，毫秒

MarketingReplyContent

字段名称	字段类型	含义说明
type	int32	文本 = 1 组件 = 7
text	MarketingReplyContentText	文本，结构见：MarketingReplyContentText
component	MarketingImComponent	高级在线预约，结构见：MarketingImComponent
before	MarketingReplyContent	在type内容之前触发，结构见：MarketingReplyContent
after	MarketingReplyContent	在type内容之后触发，结构见：MarketingReplyContent

MarketingReplyContentText

字段名称	字段类型	含义说明
text	string	文本内容

MarketingImComponent

字段名称	字段类型	含义说明
type	string	组件类型，高级在线预约-industry_advanced_online_reserve
component_id	string	组件id
component_name	string	组件名称

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.29 更新用户触达计划状态

能力说明

支持客户更新用户触达状态

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/update_marketing/
http method	post
scope	ad.leads.im_manage_marketing

接口入参：

字段名称	字段类型	是否必填	含义说明
open_id	string	是	客户账号open_id
status	int32	是	计划状态 8-关闭 9-删除
id	int64	是	计划id

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

2.30 私信防骚扰开关配置

能力说明

支持客户更新私信防骚扰开关配置

权限校验

仅限线索抖音号调用

接口详情

接口基本信息：

请求头

名称	类型	是否必传	描述
Content-type	string	true	固定值"application/json"
access-token	string	true	调用/oauth/access_token/生成的token，此token需要经营者授权
x-tt-env	string	false	测试环境联调时使用，上线时删掉 ppe_leads_open
x-use-ppe	int	false	测试环境联调时使用，上线时删掉 1

名称	描述
http url	https://open.douyin.com/api/enterprise/v1/im/update_defense_settings/
http method	post
scope	ad.leads.im_defense_settings

接口入参：

字段名称	字段类型	是否必填	含义说明
defenseSwitch	int32	是	0：关闭 1开启
effectScenes	list<int32>	是	适用场景：0：私信会话 1：官网电话 2：留资表单
effectType	list<int32>	是	拦截类型：0：异常用户 1：广告营销 2：同行咨询
reason	sting	否	用户关闭开关时选择原因
open_id	string	是	客户账号open_id

接口返回值：

字段名称	字段类型	含义说明
erro_no	int32	错误code码
err_msg	string	错误说明
log_id	string	调用链路id

错误码

http状态	错误码	错误描述	处理方式
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理

3.消息发送示例

3.1 组件消息发送

# 发送“一键收集电话”线索组件
# 请求
curl --location 'https://open.douyin.com/im/send/msg/?open_id=_0006Kco_rm-CSWgrlUVUK-SLbWmsK-H51Cs' \
--header 'access-token: act.3.WjTFwvJtv5-xazFSZi6vMnyb8fB8FJam34CcOZsDl-vsLB2OZUoDvK_v0uTpxwMVeb-UkAEag46drhGTXplWc53ZcyC4SisrNvBlPRBz24yNtvy2Iq2NlDHOw47TW8DOHzVo4V20R7Bjdg-0xU9ENGc9g8-4VEtvfikAkQ==_hl' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": {        "msg_type": 20,        "general_msg_content": {            "component_type": 8,            "component_id": 0        }    },
    "to_user_id": "_000KNrgQlElvtHDEdhdUJx_jJpPByzquGiZ",
    "msg_id": "@9VwN3OfEVco/OyKtZ9YuRM791mzuPvCKPJVzoQuuJ1cRaPH960zdRmYqig357zEBQ2a5+KXqsiu8thssCi6u4w==",
    "conversation_id": "@9VwN3OfEVco/OyKtZ9YuRM7912LhO/iCOpd3oQKlKlARZvX460zdRmYqig357zEBH+8OnomX4fax8pDLOu23/g==",
    "scene": "im_replay_msg",
    "channel": 1
}'
# 响应
{
        "extra": {
                "description": "",
                "sub_error_code": 0,
                "sub_description": "",
                "now": 1648797449,
                "logid": "021648797449846fd1b1111000700600000000000000086dfb920",
                "error_code": 0
        },
        "data": {
                "error_code": 0,
                "description": ""
        },
        "msg_id": "@c29bfc000+MNggFhRkwGuX1ntuc0RPc0VHKefj/yWEJ8DtjU=="
}

3.2 自定义一键收集电话消息发送示例

步骤1：保存「一键收集电话」电话配置

用于发送「一键收集电话」组件时查询

# 新建“一键收集电话”线索组件
# 请求
curl --location 'https://open.douyin.com/im/send/msg/?open_id=_0006Kco_rm-CSWgrlUVUK-SLbWmsK-H51Cs' \
--header 'access-token: act.3.WjTFwvJtv5-xazFSZi6vMnyb8fB8FJam34CcOZsDl-vsLB2OZUoDvK_v0uTpxwMVeb-UkAEag46drhGTXplWc53ZcyC4SisrNvBlPRBz24yNtvy2Iq2NlDHOw47TW8DOHzVo4V20R7Bjdg-0xU9ENGc9g8-4VEtvfikAkQ==_hl' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reply_id": "",
    "rule_name": "12131测试自定义文案",
    "content": {
        "type": 1,
        "text": {
            "text": "欢迎留资"
        }
    },
    "extra":"{\"leads_card_text\":true}"
}'
# 响应
{
        "extra": {
                "description": "",
                "sub_error_code": 0,
                "sub_description": "",
                "now": 1648797449,
                "logid": "021648797449846fd1b1111000700600000000000000086dfb920",
                "error_code": 0
        },
        "data": {
        "id": 12313 
    },
        
}

步骤2：查询一键留资电话配置

获取「一键收集电话」组件自定义文本的配置的id，用于步骤3发送时传入

# 查询“一键收集电话”线索组件
# 请求
curl --location 'https://open.douyin.com/im/send/msg/?open_id=_0006Kco_rm-CSWgrlUVUK-SLbWmsK-H51Cs' \
--header 'access-token: act.3.WjTFwvJtv5-xazFSZi6vMnyb8fB8FJam34CcOZsDl-vsLB2OZUoDvK_v0uTpxwMVeb-UkAEag46drhGTXplWc53ZcyC4SisrNvBlPRBz24yNtvy2Iq2NlDHOw47TW8DOHzVo4V20R7Bjdg-0xU9ENGc9g8-4VEtvfikAkQ==_hl' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reply_extra_type": 1,
}'
# 响应
{
        "extra": {
                "description": "",
                "sub_error_code": 0,
                "sub_description": "",
                "now": 1648797449,
                "logid": "021648797449846fd1b1111000700600000000000000086dfb920",
                "error_code": 0
        },
        "data": {
        "quick_reply_list": [
            {
                "reply_id": "3665496",
                "rule_name": "12131测试自定义文案",
                "content": {
                    "type": 1,
                    "text": {
                        "text": "欢迎留资"
                    }
                },
                "extra": "{\"leads_card_text\":true}"
            }
        ]
    },,
        
}

步骤3：发送自定义一键留资电话消息

# 发送“一键收集电话”线索组件
# 请求
curl --location 'https://open.douyin.com/im/send/msg/?open_id=_0006Kco_rm-CSWgrlUVUK-SLbWmsK-H51Cs' \
--header 'access-token: act.3.WjTFwvJtv5-xazFSZi6vMnyb8fB8FJam34CcOZsDl-vsLB2OZUoDvK_v0uTpxwMVeb-UkAEag46drhGTXplWc53ZcyC4SisrNvBlPRBz24yNtvy2Iq2NlDHOw47TW8DOHzVo4V20R7Bjdg-0xU9ENGc9g8-4VEtvfikAkQ==_hl' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": {
        "msg_type": 20,
        "general_msg_content": {
            "component_type": 8,
            "component_id": xxxxx // xxxxx为步骤2查询到的一键留资电话配置id
        }
    },
    "to_user_id": "_000KNrgQlElvtHDEdhdUJx_jJpPByzquGiZ",
    "msg_id": "@9VwN3OfEVco/OyKtZ9YuRM791mzuPvCKPJVzoQuuJ1cRaPH960zdRmYqig357zEBQ2a5+KXqsiu8thssCi6u4w==",
    "conversation_id": "@9VwN3OfEVco/OyKtZ9YuRM7912LhO/iCOpd3oQKlKlARZvX460zdRmYqig357zEBH+8OnomX4fax8pDLOu23/g==",
    "scene": "im_replay_msg",
    "channel": 1
}'
# 响应
{
        "extra": {
                "description": "",
                "sub_error_code": 0,
                "sub_description": "",
                "now": 1648797449,
                "logid": "021648797449846fd1b1111000700600000000000000086dfb920",
                "error_code": 0
        },
        "data": {
                "error_code": 0,
                "description": ""
        },
        "msg_id": "@c29bfc000+MNggFhRkwGuX1ntuc0RPc0VHKefj/yWEJ8DtjU=="
}

4.线索私信事件开放

能力说明

私信相关数据通过webhook的方式推送给isv，isv可在抖开订阅对应的webhook事件，获取相关的数据

名称	描述
scope	ad.leads.im_event_open

消息结构--content

字段名称	字段类型	是否必填	含义说明
invalid_conversation	Int64	否	无效会话 0-否--移除 1-是--折叠
enter_chat_from	Int64	否	进私来源 0-自然 1-广告
item_enter_from	Int64	否	内容类型 0-短视频 1-直播 5-未知
is_clued	Int64	否	是否留资 0-否 1-是
guest_id	Int64	否	访客id
enterprise_id	Int64	否	企业号id
conversation_short_id	Int64	否	会话id
create_time	Int64	否	创建时间