连接器
工具参考
已注册十五个工具。打开一个工具可查看参数和返回内容。
在助手里完成设置- whoamiwhoami()返回当前登录账户的 Hivewave 用户 ID 和邮箱。
- list_brandslist_brands()列出此账户上的品牌。在您确认一个品牌之前不会开始规划，即使只有一个品牌也一样。
- plan_directionplan_direction(brand_id?, message?, job_id?)为您已确认的品牌寻找一款产品的门店方向。第一次调用返回任务 ID。之后再用该 ID 调用，会返回方向：哪一类门店，以及这款产品为什么适合。它不会批准方向，也不会开始搜索。
- approve_directionapprove_direction(strategy_id, direction_id)批准您刚刚确认的方向。这次批准会开始搜索。返回结果不含联系人。
- list_active_directionslist_active_directions(brand_id)列出您已确认品牌下已批准的方向。
- list_scouted_candidateslist_scouted_candidates(brand_id)列出目前找到的门店：门店名称、匹配原因，以及进入 Hivewave 的链接。邮箱和电话留在应用内。
- list_email_templateslist_email_templates(brand_id)列出一个品牌的外联邮件模板。归档模板和设为默认都留在应用里。
- get_email_templateget_email_template(template_id)读取一个模板的语气字段，包括商家自己的通信地址，以及模板库链接。
- create_email_templatecreate_email_template(brand_id, name, description?, structure?, opening_style?, cta_style?, sign_off?, tone_notes?, subject_pattern?, must_include?, avoid?, anchor_examples?, compliance_footer_on_first_touch?, compliance_postal_address?)为一个品牌创建外联模板。不会把它设为默认。归档和选择默认都留在应用里。
- update_email_templateupdate_email_template(template_id, name?, description?, structure?, opening_style?, cta_style?, sign_off?, tone_notes?, subject_pattern?, must_include?, avoid?, anchor_examples?, compliance_footer_on_first_touch?, compliance_postal_address?)编辑一个模板的语气字段。省略的字段保持原样。不会归档模板，也不会改哪个是默认。
- preview_email_templatepreview_email_template(template_id?, direction_path_id?, job_id?, candidate_id?, cta_style?, avoid?, subject_pattern?, must_include?, anchor_examples?)用一个模板针对已批准的方向生成一封示例外联邮件。第一次调用返回任务 ID。之后再用该 ID 调用，会返回示例主题和正文。未指定候选人时，服务器选取该方向上最新的可联系候选人。可选的简报字段只作用于这一次示例，不会保存模板。结果不含收件人邮箱、姓名或电话。
- get_outreach_summaryget_outreach_summary(brand_id)展示一个品牌的外联进展：数量、下一次发送日，以及进度阶段。不含联系人。
- list_outreach_messageslist_outreach_messages(brand_id, bucket, direction_path_id?, q?, limit?, offset?)列出一个收件箱分组里的外联邮件。待审和已排期的行包含主题和正文。已发送、失败和暂扣的行包含主题和状态，不含正文。暂扣的行包含暂扣原因。搜索匹配主题和门店名称。不含邮箱和电话。get_outreach_message 可返回任意分组中一封邮件的正文。发送留在应用里。
- get_outreach_messageget_outreach_message(message_id)读取一封外联邮件的主题和正文，不限它所在的分组。不含邮箱和电话。
- get_outreach_send_statusget_outreach_send_status(brand_id)读取此人已在 Hivewave 应用里开始的一次发送。没有正在进行的发送时结果为 null。这个工具不会开始发送。