工具参考

MCP 工具参考

百居易暴露的 MCP 工具完整目录。本页由脚本从
resources/openapi/v3-cn.json(由 v3.json 自动翻译生成)中的 x-mcp 扩展自动生成——
如需新增或修改工具,请改 v3.json,不要直接改本页。

如何阅读本页

  • 每个工具一节 H3。可以用右侧目录或浏览器 Ctrl+F 按工具名快速跳转。
  • 工具名下面一行展示底层 HTTP 接口、副作用类型、首次暴露的 v3 版本。
  • Read-only 工具任何 Access Token 都能调用;Write 工具需要可写 Token;
    Write · requires confirmation 是不可逆 / 写密集操作,MCP 客户端应在执行前向用户确认。
  • 想看完整的参数和响应结构,请点击侧栏中对应的 reference/<endpoint> 页(spec 驱动的 API 参考),
    或者在 spec 中按 path + method 查找。

工具数量速览

分类工具数只读可写
automation312
calendar1046
finance853
knowledge_base523
messaging422
meta330
property1358
reservation18315
task826
合计722745

automation

3 个工具 —— 1 只读,2 可写

delete_automation_action

DELETE /automation/actions/{plan_id} · Write · requires confirmation · 自 v3.4.0

删除待处理的自动化计划(等待状态 send_messagereview 自动化),这样就不会发送该计划。 ⚠️ 不可逆 — 但只有这一次发生被取消;底层自动化规则保持不变,并将在下一个触发时继续生成新计划。仅支持 send_messagereview 计划。

示例语句

  • "取消此待处理的欢迎消息"
  • "不要发布此评价 - 删除它"

execute_automation_action

POST /automation/actions/{plan_id}/execute · Write · requires confirmation · 自 v3.4.0

立即触发待处理的自动化计划(等待状态 send_messagereview 自动化)。相当于在应用程序中的待处理项目上点击“立即运行”。 ⚠️ 不可逆:消息将立即发送/评价将立即发布到渠道。仅支持send_messagereview计划; review 还要求订单必须在退房日期之前完成。

示例语句

  • "立即发送此待处理的欢迎消息"
  • "立即发布此排队的正面评价"

search_automation_actions

GET /automation/actions · Read-only · 自 v3.4.0

列出待处理(等待运行)的自动化计划。涵盖两种:(1)自动消息(type=message,相当于应用内未来 30 天内的“即将发送的消息”房源); (2)自动评审(type=review)。按关键字、房间 ID、时间范围、渠道、规则事件进行过滤。常见用例:查看在某一天将自动发送哪些消息给客人,查找要手动触发或取消的特定待处理计划。

示例语句

  • "明天将发出哪些自动消息"
  • "海岸别墅即将发布的待处理消息"
  • "排队自动评价"

calendar

10 个工具 —— 4 只读,6 可写

create_calendar_share_link

POST /calendar_share_links · Write · 自 v3.5.0

创建新的公共日历共享链接。选择 scope=entire 以公开所有房间(幂等:返回现有链接(如果有)),或选择 scope=partialproperty_ids 以仅公开特定房间。返回的 url 是一个公共只读日历,房东账号可以将其交给清洁工、所有者或外部协作者。

示例语句

  • "为我的所有房间创建共享日历链接"
  • "为房间 101 和 102 生成共享链接"
  • "给我一个公共日历链接,我可以发送给我的清洁工"

delete_calendar_share_link

DELETE /calendar_share_links/{id} · Write · 自 v3.5.0

使公共日历共享链接永久失效。任何持有先前 URL 的人都会收到 share link invalid 错误。首先通过 search_calendar_share_links 查找链接 id。

示例语句

  • "撤销日历共享链接 42"
  • "删除我发送给清洁工的日历共享链接"

get_pricing_ratios

GET /pricing_ratios · Read-only · 自 v3.4.0

获取给定房间或房型的每个渠道的房源价格比率(以%为单位)。使用客户端比率计算每个房源的目标价格(target = round(base * ratio / 100)),然后循环update_listing_prices以推送新价格。带有 readonly=true 的房源无法通过 update_listing_prices 更新,必须跳过。恰好需要 property_id / room_type_id 之一。

示例语句

  • "Coastal Villa #1 各 OTA 的价格比例是多少"
  • "我想重新定价此房型 - 显示每个渠道的比率"

search_availabilities

GET /availabilities · Read-only · 自 v3.4.0

查询房间级别的可用性日历。返回请求日期范围内每个房间的每日空房状态 (available=true/false)。请注意区别:这是房间主日历(决定订单是否开放)——它与每个渠道列出的库存/价格不同(使用 search_房源_calendars )。常见用例:检查房间哪些天是空闲的,找出哪些天被订单或被阻止。

示例语句

  • "Coastal Villa #1 下个月开放的日子是哪几天"
  • "本周末哪些房间仍可订单"

search_calendar_share_links

GET /calendar_share_links · Read-only · 自 v3.5.0

搜索/分页房东账号的公共日历共享链接。返回每个链接的 id、范围(整个/部分)、它公开的 property_ids(整个范围链接为空)和共享 URL。在创建或删除链接之前,使用它来枚举现有链接。

示例语句

  • "列出我的日历共享链接"
  • "我创建了哪些日历共享链接"
  • "显示房间 123 的共享链接"

search_listing_calendars

POST /listings/calendar · Read-only · 自 v3.4.0

查询每个渠道的房源日历(日期范围内每个 channel_type + listing_id 的每日价格、库存、最短停留时间和其他限制)。注意:房源是一处房间的 OTA 端条目(Airbnb、Booking 等),并包含特定渠道的价格/库存。要查询房间主日历,请使用 search_availabilities

示例语句

  • "5 月 20 日至 30 日 Airbnb 沿海别墅价格"
  • "下周该房间的订单库存和最短入住时间"

update_availabilities

POST /availabilities · Write · requires confirmation · 自 v3.4.0

打开/阻止某房间在某个日期范围内的可用性(available=true 打开,false 阻止)。异步:响应成功才表示任务已提交;更改需要很短的时间才能传播到渠道。将级联到该房间的所有连接渠道的库存。注意:这控制房间主日历 - 与每个渠道列表库存 (update_房源_inventories) 不同。阻止错误的日期可能会导致房间无法订单或影响现有订单,因此请仔细检查日期范围。

示例语句

  • "下周一至周三,关闭 Coastal Villa #1"
  • "海岸别墅将于 5 月 20 日至 25 日重新开放"

update_listing_inventories

POST /listings/inventories · Write · requires confirmation · 自 v3.4.0

更新特定日期的渠道列表 的库存。异步——渠道端传播需要很短的时间。注意:这仅更新每个渠道的库存,不会影响房间主日历 (房间 availability);后续的主日历更改可以覆盖此设置。要打开/阻止房间主日历,请使用 update_availabilities。错误的值可能会导致超售或售罄。

示例语句

  • "下周将此房间的 Airbnb 库存设为 0"
  • "将 5 月 20 日至 25 日的订单库存设置为 1"

update_listing_prices

POST /listings/prices · Write · requires confirmation · 自 v3.4.0

更新特定日期渠道列表 的售价。异步——渠道端传播需要很短的时间。价格变化直接影响客人看到的内容和支付的费用,因此请仔细检查渠道/房源/日期/货币/金额。对于长期动态定价,更喜欢集成 PriceLabs 等服务,而不是手动调用此端点。

示例语句

  • "5 月 20 日至 25 日将此房间的 Airbnb 价格提高至 800 美元"
  • "在下周末的订单中添加 20% 的加价"

update_listing_restrictions

POST /listings/restrictions · Write · requires confirmation · 自 v3.4.0

更新特定日期渠道列表 的订单限制(最短入住天数、最多入住天数、该日期是否允许入住/退房等)。异步。常见用例:旺季期间需要至少入住 3 晚,在特定日期关闭入住。

示例语句

  • "要求下周末在 Airbnb 至少入住 2 晚"
  • "5 月 1 日的 Booking 关闭办理入住手续"

finance

8 个工具 —— 5 只读,3 可写

create_transaction

POST /transactions · Write · requires confirmation · 自 v3.4.0

记录收入或支出条目(簿记)。必需:direction (income / expense) + amount(正数)+ item_id + payment_method_id。可以链接到订单 (stay_code) 或房间 (property_id),但不能同时链接到两者;省略两者以记录房东账号级别条目(仅限主账户)。当提供 stay_code 时,currency 是从保留继承的;否则需要 currency。通过 GET /income_items/expense_items/income_methods/expense_methods 查找 item_id / payment_method_id

示例语句

  • "记录订单 ABC123 的 200 美元清洁费用"
  • "记录我们收到客人支付的 500 美元押金"
  • "沿海别墅本月维护费用为 1500 美元"

delete_transaction

DELETE /transactions/{id} · Write · requires confirmation · 自 v3.4.0

永久删除交易条目。 ⚠️ 不可逆 — 删除将影响链接的房间/订单/房东账号的累计收入/支出总额。如果只是金额错误,则使用update_transaction而不是删除。

示例语句

  • "删除此费用条目 - 记录不正确"

search_expense_items

GET /expense_items · Read-only · 自 v3.4.0

列出所有可用的费用项目类别(清洁、维护、布草、平台佣金等)。返回每个项目的 id 和名称。必需:在 create_transactiondirection=expense 之前调用此函数以获得有效的 item_id

示例语句

  • "有哪些费用类别可用"
  • "我该用哪个item_id来支付维护费"

search_expense_methods

GET /expense_methods · Read-only · 自 v3.4.0

列出所有可用的费用支付方式(现金、银行转账、信用卡等)。返回每个方法的 id 和名称。必需:在 create_transactiondirection=expense 之前调用此函数以获得有效的 payment_method_id

示例语句

  • "有哪些费用支付方式"
  • "我应该使用哪个 payment_method_id 来记录现金支出"

search_income_items

GET /income_items · Read-only · 自 v3.4.0

列出所有可用的收入项目类别(房费、押金、清洁费等)。返回每个项目的 id 和名称。必需:在 create_transactiondirection=income 之前调用此函数以获得有效的 item_id

示例语句

  • "有哪些收入类别可供选择"
  • "我应该使用哪个 item_id 来记录存款"

search_income_methods

GET /income_methods · Read-only · 自 v3.4.0

列出所有可用的收入支付方式(现金、银行转账、Stripe、PayPal 等)。返回每个方法的 id 和名称。必需:在 create_transactiondirection=income 之前调用此函数以获得有效的 payment_method_id

示例语句

  • "有哪些收入支付方式"
  • "我应该使用哪个 payment_method_id 来记录现金收据"

search_transactions

GET /transactions · Read-only · 自 v3.4.0

查询交易分录(收入/支出账本)。按方向 (income / expense)、链接订单 (stay_code)、链接房间 (property_id)、日期范围等过滤;或者直接传递 id 来获取单个条目。返回每个条目的金额、货币、项目 (item_id / item_name)、付款方式和链接对象。当使用id过滤时,start_date / end_date是可选的。

示例语句

  • "本月所有收入"
  • "本月沿海别墅 #1 的费用"
  • "与订单 ABC123 相关的所有交易"
  • "显示交易 12345 的详细信息"

update_transaction

PATCH /transactions/{id} · Write · requires confirmation · 自 v3.4.0

更新现有的交易条目。只能更改amount / item_id / payment_method_id / action_at / note及类似字段; direction(收入/支出)、链接对象(订单/房间/房东账号级别)和 currency 是不可变的 - 要更改这些,delete_transaction 并使用 create_transaction 重新创建。

示例语句

  • "将此费用金额更改为 320"
  • "更新本次交易的备注"

knowledge_base

5 个工具 —— 2 只读,3 可写

create_knowledge_base

POST /knowledge_bases · Write · requires confirmation · 自 v3.5.0

使用 AI 回复内容和范围(房间/渠道)创建新的知识库条目。

示例语句

  • "创建新的知识库条目"
  • "添加自动回复内容"

delete_knowledge_base

DELETE /knowledge_bases/{id} · Write · requires confirmation · 自 v3.5.0

删除知识库条目。

示例语句

  • "删除该知识库"
  • "删除此知识库条目"

get_knowledge_base

GET /knowledge_bases/{id} · Read-only · 自 v3.5.0

按 ID 获取单个知识库条目的完整详细信息,包括内容、范围和启用状态。

示例语句

  • "查看知识库条目详细信息"
  • "获取本知识库的内容"

search_knowledge_bases

GET /knowledge_bases · Read-only · 自 v3.5.0

搜索/分页知识库条目。按房间 ID 或渠道类型过滤。返回 id、标题、启用状态、范围和处理状态。

示例语句

  • "列出我所有的知识库条目"
  • "查找特定房间的知识库"
  • "搜索 Airbnb 渠道知识库"

update_knowledge_base

PATCH /knowledge_bases/{id} · Write · requires confirmation · 自 v3.5.0

更新知识库条目的所有字段,包括内容、范围和启用状态。

示例语句

  • "更新本知识库的内容"
  • "修改知识库的范围"
  • "启用或禁用此知识库"

messaging

4 个工具 —— 2 只读,2 可写

get_conversation

GET /conversations/{conversation_id} · Read-only · 自 v3.4.0

获取单个会话的详细信息和消息房源。首先调用search_conversations来获取conversation_id。返回每条消息的发件人、内容、时间戳和附件。

示例语句

  • "显示我们与这位客人讨论的内容"
  • "该话题的完整聊天记录"

search_conversations

GET /conversations · Read-only · 自 v3.4.0

列出会话主题。线程携带与给定客人有关的所有消息,并且可以链接到一个或多个订单。返回每个线程的 ID、最新消息预览、未读计数、链接渠道等。常见用例:查找要回复的房客线程、列出最近活动的线程。

示例语句

  • "最近有未读消息"
  • "约翰的线索在哪里"
  • "Airbnb 上的所有会话"

send_message

POST /conversations/{conversation_id} · Write · requires confirmation · 自 v3.4.0

在特定会话中向客人发送文本或图像消息。消息一旦发送就无法撤回。仔细检查 conversation_id 是否正确,并且内容符合渠道政策(Airbnb / Booking 等)——请勿包含外部联系信息或第三方链接,否则渠道可能会屏蔽消息或暂停账户。

示例语句

  • "回复这位客人并告诉他们锁码是6688"
  • "在此线程中发送欢迎消息"

update_conversation_note

PATCH /conversations/{conversation_id}/note · Write · 自 v3.7.0

设置或清除附加到会话线程的房东端私人注释。备注仅存储在百居易中,绝不会发送给房客或任何渠道;它们在账户中的房东账号之间共享,以便团队可以互相留下上下文。首先调用search_conversations来获取conversation_id。在 note 中传递空字符串或 null 以清除现有注释。返回更新的注释和 updated_at

示例语句

  • "在此线程上添加注释:VIP 客人,请始终确认延迟入住"
  • "更新此会话的注释"
  • "清除此会话的注释"

meta

3 个工具 —— 3 只读,0 可写

search_custom_channels

GET /custom_channels · Read-only · 自 v3.4.0

列出房东账号的自定义渠道(房东账号自己定义的渠道 - 例如 WhatsApp、Facebook Messenger、直接回房客户 - 在内置 Airbnb / Booking / 等之上)。返回每个渠道的 ID 和名称。当您需要 create_reservation / update_reservation_basiccustom_channel_id 时,请先调用此函数。

示例语句

  • "我有哪些自定义渠道"
  • "WhatsApp 渠道的 ID 是什么"

search_reservation_tags

GET /reservation_tags · Read-only · 自 v3.5.0

搜索/分页房东账号的订单标签字典。返回每个标签的 id、标签名称、颜色以及是否为系统默认标签。使用它可以在调用 add_reservation_tag 之前发现现有标签名称(及其 id),或者枚举管理 UI 的标签。

示例语句

  • "列出我所有的订单标签"
  • "我是否已有“VIP”订单标签"
  • "搜索包含“清洁”的订单标签"

search_tags

GET /tags · Read-only · 自 v3.4.0

列出房东账号的房间标签(附加到房间/房型的标签,而不是订单标签)。每个条目都会返回 id、名称、颜色以及应用标签的 property_ids / room_type_ids。使用 search_reservation_tags 作为订单标签字典。

示例语句

  • "有哪些房间标签可用"
  • "哪些房间带有“海滨”标签"

property

13 个工具 —— 5 只读,8 可写

create_property

POST /properties · Write · requires confirmation · 自 v3.4.0

创建一个新房间。只接受title;所有其他详细信息(地址、渠道、照片、定价等)稍后在管理门户中配置。 ⚠️ 消耗订阅房间配额中的一个插槽;当配额用完时将会失败。

示例语句

  • "创建一个名为“Coastal Villa #5”的新房间"
  • "添加另一个名为 Studio A 的房间"

create_property_group

POST /groups · Write · 自 v3.6.0

创建一个新的房间组(房东账号定义的房间集合,例如“海景套房”、“市中心公寓”)。可以选择传递 property_ids 来预分配房间。返回新组的 id、名称及其现在包含的 propertyids。首先使用 search房间 来查找房间 id。

示例语句

  • "创建一个名为“海景套房”的房间组"
  • "创建包含房间 101、102、103 的“市中心公寓”组"

create_property_tag

POST /tags · Write · 自 v3.6.0

创建一个新的房间标签(用于标记房间/房型的标签字典,例如“海滨”、“宠物友好”)。创建时可以选择关联房间 (property_ids) 和/或房型 (room_type_ids)。要在已存在的标签下标记现有房间/房型,请改用 update_property_tag。返回新标签的 id、名称、颜色、property_ids 和 room_type_ids。

示例语句

  • "创建一个名为“Beachfront”的房间标签"
  • "添加“宠物友好”标签并关联房间 101、102"

create_room_type

POST /room_types · Write · requires confirmation · 自 v3.4.0

创建新的房型。可以选择传递 property_ids 一次附加多个房间(每个房间不得已属于另一种房型)。 ⚠️ 基本订阅不支持;房型数量不能超过房间限额。

示例语句

  • "创建名为“城景大床房”的房型"
  • "创建新房型并附加房间 101、102、103"

delete_property_group

DELETE /groups/{id} · Write · 自 v3.6.0

永久删除房间组。之前附加到该组的房间不会被删除,只会被分离。首先通过search_property_groups查找组ID。

示例语句

  • "删除“旧市中心公寓”组"
  • "删除房间组 7"

delete_property_tag

DELETE /tags/{id} · Write · 自 v3.6.0

永久删除房间标签。之前标有该标签的房间和房型不会被删除,只会被分离。首先通过search_tags查找标签id。

示例语句

  • "删除“旧折扣”房间标记"
  • "删除房间标签 12"

search_channel_accounts

GET /channel_accounts · Read-only · 自 v3.4.0

列出当前房东账号连接的第三方渠道账号(Airbnb、Booking.com等)。返回每个账户的内部id、channel_type、用户名(登录/标识符)、渠道端账户id(origin_account_id)和当前授权状态(auth_status:活动/连接/断开/异常/未知)。常见用例:清点已连接的 OTA、检查给定渠道账户是否仍然在线、按 channel_type 过滤以获得 channel_account_id 以供后续房源查询。

示例语句

  • "我连接到了哪些 OTA"
  • "我的 Airbnb 账户还在线吗"
  • "我的订单账户的渠道账户 ID 是什么"

search_listings

GET /listings · Read-only · 自 v3.4.0

列出从连接的渠道账户同步的 房源(OTA 端房间条目)。房源代表一个房间在一个渠道上的发布,并由 listing_id(渠道端 ID)+ channel_type 唯一标识。可以通过 channel_account_id(来自 search_channel_accounts)、listing_idchannel_type 进行过滤。返回每个房源的标题、封面图像、深层链接 URL、库存、货架状态 (shelf_status) 和传递 metadata 对象(地理/图像/费率计划和其他渠道端元数据;结构因渠道而异)。常见用例:清点每个 OTA 上的房源、在渠道账户下查找特定房源、在定价/限制工作流程之前获取 listing_id

示例语句

  • "我在 Airbnb 上有哪些房间"
  • "该订单账户下有多少房间"
  • "OTA 上的海岸别墅发布在哪里"

search_properties

GET /properties · Read-only · 自 v3.4.0

搜索/分页房东账号的房间。返回每个房间的 ID、名称、地址、状态和连接的渠道。常见用例:列出所有可供选择的房间、通过 ID 查找房间名称、在入门期间浏览资产列表。

示例语句

  • "列出我所有的房间"
  • "我有多少房间"
  • "1号海岸别墅的id是什么"

search_property_groups

GET /groups · Read-only · 自 v3.4.0

列出房间组。组是房东账号定义的房间集合(例如“海景套房”、“市中心公寓”、“由清洁工 A 处理”)。返回每个组的 ID、名称和关联的房间 ID。常见用例:批量操作或按组过滤。

示例语句

  • "我有哪些房间组"
  • "哪些房间属于海景套房组"

search_room_types

GET /room_types · Read-only · 自 v3.4.0

列出房型。房型对同类的可互换房间进行分组,并用于按房型库存进行销售(相对于销售特定房间)。返回每种房型的 ID、名称和关联房间。

示例语句

  • "列出我的房型"
  • "我有哪些房型"

update_property_group

PATCH /groups/{id} · Write · 自 v3.6.0

重命名房间组和/或替换其房间分配。 property_ids 替换完整列表(不是附加的):要添加房间,请首先通过 search_property_groups(id=...) 获取当前 ids,然后使用组合列表进行 PATCH。传递一个空数组以从组中分离所有房间。

示例语句

  • "将第 5 组重命名为“海岸线别墅”"
  • "将 110 号房间添加到“海景套房”组"
  • "删除组 7 中的所有房间"

update_property_tag

PATCH /tags/{id} · Write · 自 v3.6.0

重命名房间标签、更改其颜色或替换其附加的房间/房型。 property_idsroom_type_ids 都替换完整列表(不是附加的):要向标签添加房间而不删除现有房间,请首先通过 search_tags(id=...) 获取当前 id,然后使用组合列表进行 PATCH。传递一个空数组以将所有房间/房型与标签分离。

示例语句

  • "将房间标签 3 重命名为“Oceanfront”"
  • "将房间 110、111 附加到“宠物友好”标签"
  • "从“家庭套房”标签中分离所有房型"

reservation

18 个工具 —— 3 只读,15 可写

add_reservation_tag

POST /reservations/{stay_code}/tags · Write · 自 v3.4.0

为订单添加标签。如果该标签不存在,则会自动创建。常见用例:标记 VIP 客人、有问题的订单、需要特别注意的订单。

示例语句

  • "将此订单标记为 VIP"
  • "将此订单标记为“接送已确认”"

allocate_reservation

POST /reservations/{stay_code}/allocate · Write · requires confirmation · 自 v3.4.0

将订单入住分配/重新分配给特定房间。典型场景:(1)房型订单(按房型销售)订单后需要分配到具体的房间; (2) 将冲突的订单重新分配给同一房型的另一个空置房间。 ⚠️ 如果目标房间在同一日期范围内已有住宿,该住宿将被标记为冲突并移至订单盒。

示例语句

  • "将订单 ABC123 分配给 Coastal Villa #1"
  • "将此订单移至 2 号别墅"

approve_reservation

POST /reservations/{reservation_code}/approve · Write · requires confirmation · 自 v3.4.0

批准等待房东确认的订单 (status=wait_accept)。系统将调用渠道确认订单,并通知房东已接受。 ⚠️ 不可逆。仅适用于 wait_accept 状态的订单(即客人发送订单请求等待房东批准的渠道订单 - 主要是 Airbnb 的“订单请求”等)。针对已确认或取消的订单的呼叫将会失败。

示例语句

  • "批准订单 ABC123"
  • "接受该客人的订单请求"

cancel_reservation

DELETE /reservations/{reservation_code} · Write · requires confirmation · 自 v3.4.0

取消直接订单。 ⚠️ 不可逆转,将立即释放该房间的占用。该接口仅支持取消直接订单——渠道订单(Airbnb/Booking/Agoda等)必须在渠道端取消。错误的取消可能会导致客人无房并引发退款纠纷。

示例语句

  • "取消订单 ABC123"
  • "客人不会来 — 取消此直接订单"

create_reservation

POST /reservations · Write · requires confirmation · 自 v3.4.0

创建直接订单,绕过任何 OTA 渠道。需要房间 ID、入住/退房日期、客人姓名和联系方式、价格等。直接订单在系统中被视为完整订单,并支持完整的付款/收据流程。注意:此端点不能用于记录 Airbnb / Booking / 等渠道订单(这些订单从每个渠道同步)。

示例语句

  • "直接订单 Coastal Villa #1,5 月 20 日至 22 日,客人 John,3 人,600 美元"
  • "记录回头客的直接订单"

create_reservation_tag

POST /reservation_tags · Write · 自 v3.5.0

在房东账号的字典中创建订单标签,以便稍后可以通过 add_reservation_tag 将其附加到订单。当用户想要定义一个全新的标签(例如“取件已确认”)时使用此选项。请注意,如果标签不存在,add_reservation_tag 将会自动创建一个标签;仅当用户明确想要管理字典本身时才首选此端点。

示例语句

  • "创建一个名为“回头客”的订单标签"
  • "在我的订单标签列表里添加「延迟入住」"

create_review

POST /reviews/{reservation_code} · Write · requires confirmation · 自 v3.4.0

撰写房东对房客的评价,或房东对房客评价的回复。 ⚠️ 不可逆转,将在渠道(Airbnb / Booking等)上公开展示,影响房东和房客的声誉评分。代主起草时,请确保内容客观,不包含任何联系信息或外部链接(否则渠道可能会屏蔽或处罚房源)。

示例语句

  • "为客人 ABC123 写正面评价: 准时,尊重住宿"
  • "回复客人对订单XYZ的评价"

decline_reservation

POST /reservations/{reservation_code}/decline · Write · requires confirmation · 自 v3.4.0

拒绝等待主机确认的预留 (status=wait_accept)。 ⚠️ 不可逆;房客将收到房东拒绝的通知。频繁拒绝可能会损害房东在 Airbnb 和类似渠道上的接受率。仅适用于 wait_accept 状态的订单。

示例语句

  • "拒绝订单 ABC123"
  • "拒绝该客人的订单请求"

delete_reservation_tag

DELETE /reservation_tags/{id} · Write · 自 v3.5.0

从房东账号的字典中永久删除订单标签。只能删除自定义标签(来自 search_reservation_tags 的 is_default = false)。删除还会将标签与其应用到的每个订单分离。首先通过 search_reservation_tags 查找标签 id。

示例语句

  • "删除订单标签“回头客”"
  • "从我的标签列表中删除“延迟入住”标签"

move_reservation_to_box

POST /reservations/{stay_code}/move_to_box · Write · requires confirmation · 自 v3.4.0

将订单的住宿时间移至订单盒中。一旦进入框中,住宿就会从主日历视图中消失,但订单本身不会取消,也不会通知客人。常见用例:暂时搁置冲突或异常的订单,直到可以处理它们;稍后使用 allocate_reservation 将住宿重新分配给特定房间。

示例语句

  • "暂时将订单ABC123移至订单箱"
  • "把这个相互冲突的保留收起来"

remove_reservation_tag

DELETE /reservations/{stay_code}/tags · Write · 自 v3.4.0

从订单中删除标签。

示例语句

  • "从此订单中删除 VIP 标签"

search_reservation_custom_fields

GET /reservations/{stay_code}/custom_fields · Read-only · 自 v3.4.0

获取订单自定义字段的当前定义和值。自定义字段由房东账号在系统设置中定义,以保存额外的业务特定信息(车牌、过敏、特殊要求等)。在调用 update_reservation_custom_fields 之前,首先调用此函数来获取字段 ID 和当前值。

示例语句

  • "显示订单 ABC123 上的所有自定义字段"
  • "此订单的车牌字段是什么"

search_reservations

GET /reservations · Read-only · 自 v3.4.0

搜索订单。按订单代码、渠道订单 ID、房间、状态、入住/退房日期范围等进行过滤。返回订单列表,包括客人信息、住宿状态、价格和渠道。常见用例:按日期/房间/状态查找订单,或检查给定的订单是否存在。默认情况下,返回未来 180 天内使用 check_out 的订单。

示例语句

  • "订单下周入住"
  • "哪些客人明天退房"
  • "Airbnb 上未经确认的订单"
  • "本月海岸别墅全部订单"

search_reviews

GET /reviews · Read-only · 自 v3.4.0

列出评价。按渠道、房间、评分、回复状态等过滤。返回每个评价的渠道、订单、客人、评分、内容和房东回复(如果有)。常见用例:显示最近的低评分评价,查找未回复的评价来处理。

示例语句

  • "显示最近的低评分评价"
  • "本月沿海别墅 #1 的所有评价"
  • "哪些评价尚未回复"

update_reservation_basic

PATCH /reservations/{stay_code} · Write · requires confirmation · 自 v3.4.0

更新订单的基本信息:客人姓名/电话/电子邮件、入住/退房日期、团体人数、价格、备注(remarks / channel_remarks)等。常见用例:编辑备注、更新客人的联系信息、更改日期。注意:更改日期可能会与其他订单发生冲突 - 请在致电前核实。

示例语句

  • "将订单ABC123的备注更改为“已收取押金”"
  • "更改此订单以便于 5 月 20 日至 22 日入住"
  • "更新客人的电话号码"

update_reservation_checkin_details

PATCH /reservations/{stay_code}/check_in_details · Write · requires confirmation · 自 v3.4.0

更新订单的入住详细信息:锁密码、预计抵达/离开时间、押金信息等。常见用例:在客人抵达之前在管理员中设置门锁密码,记录预计抵达时间,以便安排清洁服务。该端点不会通知房客 - 如果需要通知房客,请与 send_message 配对。

示例语句

  • "将订单锁码ABC123设置为6688"
  • "请注意,客人将于14:00抵达"

update_reservation_custom_fields

PATCH /reservations/{stay_code}/custom_fields · Write · requires confirmation · 自 v3.4.0

更新订单的自定义字段的值。自定义字段由房东账号在系统设置中定义,以保存额外的业务特定信息(车牌、过敏、特殊要求等)。建议首先调用 search_reservation_custom_fields 获取字段定义和当前值,然后调用此端点进行更新。

示例语句

  • "将预留 ABC123 上的车牌字段设置为 CA-7XYZ123"
  • "记录该客人对花生过敏"

update_reservation_stay_status

PUT /reservations/{stay_code}/stay_status · Write · 自 v3.4.0

更新订单的住宿状态 (stay_status),例如checkin_pending(等待入住)→ in_house(入住)→ stay_completed(退房)。常见用例:手动处理签入/签出。

示例语句

  • "将此订单标记为已登记"
  • "客人已退房 - 标记它"
  • "报到 ABC123"

task

8 个工具 —— 2 只读,6 可写

create_staff

POST /staffs · Write · requires confirmation · 自 v3.4.0

创建一名工作人员/承包商(清洁工、维护技术员、接待员、管家等)。默认为 active。使用 property_ids 将员工限制为特定房间(省略授权所有房间)。对于国际房东账号,mobile 必须使用 +<country code> <number> 格式,例如+1 4155550100

示例语句

  • "添加一位名为 Mary 的新清洁工,电话 +1 4155550100"
  • "添加一名维修技术员,只为 Coastal Villa #1 提供服务"

create_task

POST /tasks · Write · requires confirmation · 自 v3.4.0

创建任务(清洁/维护/接待/客房服务/其他)。可以选择链接到房间 (property_id)、订单 (stay_code) 或分配给工作人员 (staff_id)。当提供 stay_code 时,任务将绑定到该预留,如果省略,property_id 默认为预留的房间。 type选择任务类别; level仅对清洁任务有意义。

示例语句

  • "明天早上为 Coastal Villa #1 创建清洁任务"
  • "创建预留ABC123的清洁任务"
  • "将维护任务分配给 John"

delete_staff

DELETE /staffs/{id} · Write · requires confirmation · 自 v3.4.0

永久删除员工/承包商及其所有房间授权。 ⚠️ 不可逆。如果您只想暂时禁用五线谱,请使用 update_staff 来设置 is_active=false

示例语句

  • "从员工中删除 John"
  • "删除莉莉——她已经离开公司"

delete_task

DELETE /tasks/{id} · Write · requires confirmation · 自 v3.4.0

永久删除任务。 ⚠️ 不可逆 — 任务历史记录和相关人员分配记录被擦除。如果您只想将其标记为完成或取消,请使用 update_task 更改 status

示例语句

  • "删除任务123"
  • "删除这个清洁任务——我错误地创建了它"

search_staffs

GET /staffs · Read-only · 自 v3.4.0

列出员工/承包商(清洁工、维护技术员、接待员、管家等)。返回每个员工的 ID、姓名、类型和联系方式。常见用例:在调用 create_task / update_task 之前按名称查找 staff_id

示例语句

  • "我有哪些清洁工"
  • "维修技术人员的电话号码是多少"
  • "约翰的员工 ID 是什么"

search_tasks

GET /tasks · Read-only · 自 v3.4.0

搜索任务(清洁/维护/接待/客房服务/其他)。按 id(获取一项任务)、状态、类型、房间、人员、日期范围等进行过滤。返回每个任务的 ID、类型、房间、分配的人员、状态、预期执行时间等。传递 id 以获取单个任务的详细信息。

示例语句

  • "我今天有哪些清洁任务"
  • "下周沿海别墅 #1 的所有任务"
  • "打开维护任务"
  • "显示任务 123 的详细信息"

update_staff

PATCH /staffs/{id} · Write · requires confirmation · 自 v3.4.0

更新员工信息。所有字段都是可选的;仅更改提供的字段。 ⚠️ 注:通过property_ids完全取代员工的授权房间清单(不附后);传递空数组会清除所有授权。使用 is_active 启用/禁用五线谱。

示例语句

  • "将玛丽的电话号码更改为 +1 4155550199"
  • "停用约翰"
  • "让 Lily 为 1 号别墅和 2 号别墅提供服务"

update_task

PATCH /tasks/{id} · Write · requires confirmation · 自 v3.4.0

更新现有任务。所有字段都是可选的;仅更改提供的字段。通过 property_id=0staff_id=0 将任务与其房间/人员分离。常见用例:更改任务状态(例如标记为已完成)、重新分配人员、更改预期时间、添加注释。

示例语句

  • "将此任务标记为已完成"
  • "将此任务重新分配给 Lily"
  • "将此清洁任务重新安排到下午 3 点"