# Myhostex.com OpenAPI Documentation ## API Reference - [概览](https://api-doc.myhostex.com/reference/overview.md): Welcome to the Hostex API, where seamless integration meets comprehensive management of property and reservation systems. Our API provides a powerful suite of features for developers looking to automate and interact with the Hostex platform. - [快速开始](https://api-doc.myhostex.com/reference/quickstart.md) - [变更日志](https://api-doc.myhostex.com/reference/changelog.md) - [查询房间](https://api-doc.myhostex.com/reference/query-properties.md): 您可以通过向此端点发出请求来查询房间。 - [查询分组](https://api-doc.myhostex.com/reference/query-groups.md): 您可以通过向此端点发出请求来查询房间组。 - [创建房间](https://api-doc.myhostex.com/reference/create-property.md): 在当前房东账号下创建一个新的房间(房间)。百居易房间是物理房间单元;之后可以通过 百居易后台 将 OTA 房源附加到房间。新创建的房间没有地址、渠道或图片,并以房东账号的默认入住/退房时间设置开始。受房东账号认购的房间数量限制。 - [查询标签](https://api-doc.myhostex.com/reference/query-tags.md): 您可以通过向此端点发出请求来查询标签。 - [创建分组](https://api-doc.myhostex.com/reference/create-group.md): 创建一个新的房间组。可以选择在创建时通过 `property_ids` 预先关联房间。组名称在房东账号账户中必须是唯一的。 - [更新分组](https://api-doc.myhostex.com/reference/update-group.md): 更新房间组。通过`name`进行重命名;传递 `property_ids` 以用提供的房源**替换**组的完整房间分配(传递一个空数组以分离所有房间)。省略的字段保持不变。 - [删除分组](https://api-doc.myhostex.com/reference/delete-group.md): 删除房间组。所有房间组枢轴行都会自动删除;底层房间本身不受影响。 - [创建标签](https://api-doc.myhostex.com/reference/create-tag.md): 创建一个新的房间标签。可以选择通过 `property_ids` 预先关联房间和/或通过 `room_type_ids` 预先附加房型。该名称在房东账号账户中必须是唯一的(软删除的同名标签将被恢复)。颜色是从百居易调色板自动分配的,除非提供了允许的十六进制字符串之一。房东账号的房间标签上限为 500 个。 - [更新标签](https://api-doc.myhostex.com/reference/update-tag.md): 更新房间标签。通过 `name` 和/或 `color` 来更改标签本身;传递 `property_ids` 和/或 `room_type_ids` 来**替换**标签的完整分配房源。传递一个空数组来分离所有房间/所有房型。省略的字段保持不变。 - [删除标签](https://api-doc.myhostex.com/reference/delete-tag.md): 删除房间标签。所有房间标签和房型标签数据透视行都会自动删除;基础房间/房型本身不受影响。 - [查询房型](https://api-doc.myhostex.com/reference/query-room-types.md): 您可以通过向该端点发起请求来查询房型。 - [创建房型](https://api-doc.myhostex.com/reference/create-room-type.md): 在当前房东账号下创建新的房型。房型是作为单个库存池出售的一组可互换的房间(房间)。可以选择在创建时通过 `property_ids` 链接现有房间 - 每个链接的房间不得已属于其他房型。受房东账号订阅的房型数量限制(以房间数量限制为上限),且不适用于基本版。 - [查询订单](https://api-doc.myhostex.com/reference/query-reservations.md): 您可以通过向此端点发出请求来查询订单。 - [创建订单](https://api-doc.myhostex.com/reference/create-reservation.md): 在百居易中创建订单(直订单)。 - [取消订单](https://api-doc.myhostex.com/reference/cancel-reservation-1.md): 取消百居易中的直订单。请注意,该接口不支持取消渠道订单。 - [更新入住详情](https://api-doc.myhostex.com/reference/update-check-in-details.md): 更新入住的入住详情,包括锁码、抵达/离开时间和押金信息。 - [更新订单基本信息](https://api-doc.myhostex.com/reference/update-reservation-basic-info.md): 更新住宿的基本信息,包括客人详细信息、日期、价格和其他房间。 - [查询自定义渠道](https://api-doc.myhostex.com/reference/query-custom-channels.md): 查询在[自定义选项页面](https://www.myhostex.com/app/settings/custom-options)中创建的自定义渠道。 - [自定义字段指南](https://api-doc.myhostex.com/reference/custom-fields-guide.md) - [查询自定义字段](https://api-doc.myhostex.com/reference/query-custom-fields.md): 查询入住的自定义字段。欲了解更多信息,请参阅[Custom Fields Guide](/reference/custom-fields-guide)。 - [更新自定义字段](https://api-doc.myhostex.com/reference/update-custom-fields.md): 更新住宿的自定义字段。欲了解更多信息,请参阅[Custom Fields Guide](/reference/custom-fields-guide) - [移入订单盒](https://api-doc.myhostex.com/reference/move-reservation-to-box.md): 将订单的住宿移至订单盒。当您想要暂时从活动日历视图中删除订单时,通常会使用此操作。 - [分配到房间](https://api-doc.myhostex.com/reference/allocate-reservation.md): 将订单分配给特定房间。此操作用于将订单分配或重新分配给特定房间。如果目标房间已有住宿,则会将其标记为冲突住宿并移至订单盒。 - [更新入住状态](https://api-doc.myhostex.com/reference/update-stay-status.md): 更新订单的住宿状态。此端点允许您在不同状态之间更改住宿的状态,例如待办理入住、内部入住和住宿已完成。 - [接受订单](https://api-doc.myhostex.com/reference/approve-reservation.md): 批准待处理的订单请求。订单状态必须为 `wait_accept`。该端点与渠道通信以确认订单。 - [拒绝订单](https://api-doc.myhostex.com/reference/decline-reservation.md): 拒绝待处理的订单请求。订单状态必须为 `wait_accept`。该端点与渠道通信以拒绝订单。 - [添加标签](https://api-doc.myhostex.com/reference/add-tag.md): 为订单添加标签。如果该标签不存在,则会自动创建。 - [移除标签](https://api-doc.myhostex.com/reference/remove-tag.md): 从订单中删除标签。 - [订单费用明细](https://api-doc.myhostex.com/reference/reservation-rate-details.md) - [查询房间房态](https://api-doc.myhostex.com/reference/query-availabilities.md): 通过向此端点发送请求,您可以检索房间的可用性。 - [更新房间房态](https://api-doc.myhostex.com/reference/update-availabilities.md): 使用此端点更新房间可用性。

请注意,成功响应仅表明我们已启动异步任务来处理您的提交; DOES NOT 确保渠道库存已成功修改。如果您想查看任务执行的详细结果,请访问[百居易后台](https://www.myhostex.com/app/calendar)。 - [查询渠道日历](https://api-doc.myhostex.com/reference/query-listing-calendars.md): 通过向此端点发送请求,您可以检索多个房源的日历信息。此端点将返回有关每个房源的价格、库存和限制的每日详细信息。 - [查询定价比例](https://api-doc.myhostex.com/reference/query-pricing-ratios.md): 返回与房间 (`property_id`) 或房型 (`room_type_id`) 关联的每个 OTA 房源的每渠道定价比率。定价比率是百居易乘以基本(房间/房型水平)价格的**百分比**,得出每个房间的实际价格。在技​​能层使用此端点来组成“按房间/房型更改价格”工作流程:读取比率,为每个非只读房源计算 `target_price = round(base_price * ratio / 100)`,然后为每个房源调用一次 `POST /listings/prices`。标记为 `readonly: true` 的房间由渠道默默控制(例如 Airbnb 儿童房价计划),并且无法通过 `POST /listings/prices` 重新定价;跳过它们。 - [更新 房源 库存](https://api-doc.myhostex.com/reference/update-listing-inventories.md): 更新渠道列表 的库存。

请注意,成功响应仅表明我们已启动异步任务来处理您的提交; DOES NOT 确保渠道库存已成功修改。如果您想查看任务执行的详细结果,请访问[百居易后台](https://www.myhostex.com/app/price)。

此外,您应该注意,此端点仅修改房源的库存,而 不会影响房间的可用性。如果修改了房间可用性,仍然可能会导致渠道库存再次被覆盖。 - [更新 房源 价格](https://api-doc.myhostex.com/reference/update-listing-prices.md): 更新渠道列表 的价格。

请注意,成功响应仅表明我们已启动异步任务来处理您的提交; DOES NOT 确保渠道价格已成功修改。如果您想查看任务执行的详细结果,请访问[百居易后台](https://www.myhostex.com/app/price)。 - [更新 房源 限制](https://api-doc.myhostex.com/reference/update-listing-restrictions.md): 更新渠道列表 的限制。

请注意,成功响应仅表明我们已启动异步任务来处理您的提交; DOES NOT 确保渠道限制已成功修改。如果您想查看任务执行的详细结果,请访问[百居易后台](https://www.myhostex.com/app/price)。 - [更新 Airbnb 房源价格与规则](https://api-doc.myhostex.com/reference/update-airbnb-listing-price-and-rules.md): 更新 Airbnb 房源的房源级别价格、费用、预订设置与可订规则。

与日历接口不同,此接口更新房源的默认设置(而非指定日期区间)。仅更新所传字段;不传的字段保持不变。

该请求会同步提交至 Airbnb:返回成功表示变更已被 Airbnb 接受。 - [查询 Airbnb 房源价格与规则](https://api-doc.myhostex.com/reference/get-airbnb-listing-price-and-rules.md): 实时从 Airbnb 拉取房源当前的价格、可订规则与预订设置。响应字段与 `POST /listings/airbnb/price_and_rules` 接受的 `settings` 对象一一对应,读取到的值可直接原样写回。 该接口每次请求会调用多个 Airbnb 接口,因此与写操作共用更严格的限流(每分钟 120 次)。 - [更新 Vrbo 房源价格与规则](https://api-doc.myhostex.com/reference/update-vrbo-listing-price-and-rules.md): 更新 Vrbo 房源的房源级别价格、费用与预订规则。

与日历接口不同,此接口更新房源的默认设置(而非指定日期区间)。仅更新所传字段;不传的字段保持不变。

该请求会同步提交至 Vrbo:返回成功表示变更已被 Vrbo 接受。 - [查询 Vrbo 房源价格与规则](https://api-doc.myhostex.com/reference/get-vrbo-listing-price-and-rules.md): 查询 百居易 当前记录的 Vrbo 房源价格与规则。数据为 百居易 与 Vrbo 保持同步的快照(通过 百居易 修改或房源重新同步时更新),并非实时读取 Vrbo。响应字段与 `POST /listings/vrbo/price_and_rules` 接受的 `settings` 对象一一对应。 - [查询会话](https://api-doc.myhostex.com/reference/query-conversations.md): 该接口用于查询房客询问的会话房源。 - [获取会话详情](https://api-doc.myhostex.com/reference/get-conversation-details.md): 该端点用于检索会话的消息和详细信息。

我们正在不断改进我们的 API,这可能意味着消息架构可能会发生变化。为了保持健康的集成,您的应用程序必须解析并忽略意外的参数,而不是抛出错误。 - [发送消息](https://api-doc.myhostex.com/reference/send-message.md): 向客人发送文字或图像消息。 - [更新会话备注](https://api-doc.myhostex.com/reference/update-conversation-note.md): 设置或清除附加到会话线程的房东的私人注释。该注释仅存储在百居易中(在百居易收件箱中可见),**不会**发送给房客或推送到任何渠道,并在同一账户内的房东账号之间共享。在 `note` 中传递空字符串或 `null` 以清除现有注释。 - [获取特惠报价](https://api-doc.myhostex.com/reference/get-special-offers.md): 列出会话中已发送的特惠报价与预先批准及其当前状态。使用返回的 `id` 可撤回仍处于有效状态的报价。仅 Airbnb 与直订网站(booking site)会话可能包含特惠报价。 - [发送特惠报价](https://api-doc.myhostex.com/reference/send-special-offer.md): 在会话中向客人发送特惠报价。特惠报价邀请客人以自定义总价预订指定房源与日期,通常在发送后 24 小时过期。仅支持 Airbnb 与直订网站(booking site)会话,其他渠道的请求将返回错误。直订网站会话还需提供 `rate_plan_id` 与 `currency`。 - [撤回特惠报价](https://api-doc.myhostex.com/reference/withdraw-special-offer.md): 撤回此前发送且仍处于有效状态的特惠报价或预先批准。`special_offer_id` 为 `GET /conversations/{conversation_id}/special_offers` 返回的报价 `id`。 - [发送预先批准](https://api-doc.myhostex.com/reference/send-preapproval.md): 预先批准会话中客人的咨询,邀请客人按标准价格预订其咨询的房源与日期。仅支持 Airbnb 会话,其他渠道的请求将返回错误。预先批准通常在发送后 24 小时过期。无需请求体。 - [查询评价](https://api-doc.myhostex.com/reference/query-reviews.md): 查询评价,与[评价页面](https://www.myhostex.com/app/reviews)相同。 - [创建评价](https://api-doc.myhostex.com/reference/create-review.md): 创建评价或回复订单。 - [查询即将进行的自动化操作](https://api-doc.myhostex.com/reference/query-automation-actions.md): 返回等待运行的预定自动化**操作:自动**消息**(`type=message`,与应用内“即将到来的消息操作”房源相同的范围,在接下来的 30 天内)或自动**评价** (`type=review`)。过滤器镜像内部自动化计划房源(关键字、房间 ID、时间范围、渠道类型、规则事件过滤器)。分页与其他 v3 房源端点一样使用 `offset` 和 `limit`。 - [立即执行自动化动作](https://api-doc.myhostex.com/reference/execute-automation-action.md): 立即发送**等待**消息或查看自动化计划(与在应用程序中执行即将执行的操作相同的行为)。对于**查看**计划,订单必须已达到房东账号时区的退房日期。需要**可写**访问令牌。仅支持 `send_message` 和 `review` 计划类型。 - [删除待执行的自动化动作](https://api-doc.myhostex.com/reference/delete-automation-action.md): 删除 **等待** 消息或查看自动化计划而不运行它(与删除应用程序中即将执行的操作相同)。需要**可写**访问令牌。仅支持 `send_message` 和 `review` 计划类型。 - [查询任务](https://api-doc.myhostex.com/reference/query-tasks.md): 您可以通过向此端点发出请求来查询计划任务(清洁/维护/接待/家政/其他)。 - [创建任务](https://api-doc.myhostex.com/reference/create-task.md): 创建计划任务。该任务可能与房间 (`property_id`)、特定住宿 (`stay_code`) 相关联,和/或分配给员工 (`staff_id`);全部都是可选的。当提供 `stay_code` 时,任务将链接到订单;当省略时,`property_id` 是根据住宿推断的(并且在提供两者时必须与住宿的房间相匹配)。 `type` 选择任务类别,`level` 仅对清洁任务有意义。 - [更新任务](https://api-doc.myhostex.com/reference/update-task.md): 更新现有任务。所有字段都是可选的;仅更改提供的字段。通过 `property_id=0` 或 `staff_id=0` 将任务与相关房间或人员分离。 - [删除任务](https://api-doc.myhostex.com/reference/delete-task.md): 永久删除任务。如果任务不存在或当前房东账号无法访问,则返回 404。 - [查询员工](https://api-doc.myhostex.com/reference/query-staffs.md): 您可以通过向该端点发出请求来查询排班人员(清洁工/房东账号/接待员等)。 - [创建员工](https://api-doc.myhostex.com/reference/create-staff.md): 创建一个时间表人员。默认情况下,人员被创建为活动人员。使用 `property_ids` 将员工限制为特定房间;当省略时,将创建可以访问所有房间的员工。 对于国际房东账号,`mobile` 必须采用 `+ ` 格式(例如 `+86 13800138000`)。 - [更新员工](https://api-doc.myhostex.com/reference/update-staff.md): 更新现有员工。所有字段都是可选的;仅更改提供的字段。传递`property_ids`会替换员工的完整房间分配房源(使用空数组来清除)。使用 `is_active` 启用或禁用员工。 - [删除员工](https://api-doc.myhostex.com/reference/delete-staff.md): 永久删除员工及其房间分配。如果员工不存在或当前房东账号无法访问,则返回 404。 - [查询收支](https://api-doc.myhostex.com/reference/query-transactions.md): 查询针对房东账号、房间或订单记录的收入和费用条目(也称为 `transactions`)。 响应为每个条目提供其分类 (`item_id` / `item_name`) 和付款方式 (`payment_method_id` / `payment_method_name`)。 `item_id` 和 `payment_method_id` 的值引用 `GET /income_items`、`GET /expense_items`、`GET /income_methods` 和 `GET /expense_methods` 返回的字典(应用哪个字典取决于 `direction`)。 - [创建收支记录](https://api-doc.myhostex.com/reference/create-transaction.md): 记录新的收入或支出条目。该条目所链接的内容是从请求中推断出来的: - 提供 `stay_code` 来记录特定住宿的条目, - 提供 `property_id` 来记录针对特定房间的条目, - 不提供记录房东账号级别的条目(不与任何特定房间或住宿绑定;仅适用于主房东账号)。 `stay_code` 和 `property_id` 是互斥的。 `direction` 字段决定条目是 `income` 还是 `expense`,这又决定了 `item_id`(`GET /income_items` 或 `GET /expense_items`)和 `payment_method_id`(`GET /income_methods` 或 `GET /expense_methods`)使用哪些字典。 `amount` 始终以正数形式提供;符号由 `direction`。 `currency` 随金额一起提供,并且必须提供,除非提供了 `stay_code`,在这种情况下,它是从订单订单继承的,如果您提供了它,它必须与订单的货币相匹配。 - [删除收支记录](https://api-doc.myhostex.com/reference/delete-transaction.md): 删除交易条目。该操作是不可逆的。如果该条目不存在或当前房东账号无法访问,则返回 404。 - [更新收支记录](https://api-doc.myhostex.com/reference/update-transaction.md): 更新现有的交易条目。只能修改下面列出的字段。条目的`direction`、链接目标(相关房间/保留/操作符)和`currency`是不可变的;如果您需要更改其中任何一项,请删除该条目并创建一个新条目。 - [查询收入项目](https://api-doc.myhostex.com/reference/query-income-items.md): 查询房东账号可用的收入项目分类字典。对于具有 `direction=income` 的条目,返回的 `id` 与 `GET /transactions` 返回的 `item_id` 相匹配。 - [查询收入方式](https://api-doc.myhostex.com/reference/query-income-methods.md): 查询房东账号可用的支付方式字典以获取收入条目。对于具有 `direction=income` 的条目,返回的 `id` 与 `GET /transactions` 返回的 `payment_method_id` 相匹配。 - [查询支出项目](https://api-doc.myhostex.com/reference/query-expense-items.md): 查询房东账号可用的费用项目分类字典。对于具有 `direction=expense` 的条目,返回的 `id` 与 `GET /transactions` 返回的 `item_id` 相匹配。 - [查询支出方式](https://api-doc.myhostex.com/reference/query-expense-methods.md): 查询房东账号可用的支付方式字典以获取费用条目。对于具有 `direction=expense` 的条目,返回的 `id` 与 `GET /transactions` 返回的 `payment_method_id` 相匹配。 - [查询知识库](https://api-doc.myhostex.com/reference/query-knowledge-bases.md): 您可以通过向此端点发出请求来查询知识库条目。结果是分页的,并且可以按房间或渠道进行过滤。 - [创建知识库](https://api-doc.myhostex.com/reference/create-knowledge-base.md): 为 HostGPT 自动化助手创建新的知识库条目。该条目定义了 AI 内容及其适用的房间/渠道范围。 - [获取知识库详情](https://api-doc.myhostex.com/reference/get-knowledge-base.md): 通过 ID 检索单个知识库条目的完整详细信息。 - [更新知识库](https://api-doc.myhostex.com/reference/update-knowledge-base.md): 替换现有的知识库条目。此端点执行 **完全替换** — `scope_property`、`scope_channel`、`contents` 和 `is_enable` 必须全部提供。如果您只想更改一个字段,请先使用 `GET /knowledge_bases/{id}`。 - [删除知识库](https://api-doc.myhostex.com/reference/delete-knowledge-base.md): 通过 ID 删除知识库条目。 - [查询渠道账号](https://api-doc.myhostex.com/reference/query-channel-accounts.md): 查询房东账号已接入的第三方渠道账号(Airbnb、Booking.com等)。每个条目都会公开账户身份和当前授权状态。使用 `id` 获取单个账户。 - [查询 房源](https://api-doc.myhostex.com/reference/query-listings.md): 查询从房东账号关联的渠道账户同步的 房源(第三方房间)。房源是存在于特定渠道上的房间,由 `listing_id`(渠道端房间 ID)标识。按 `channel_account_id`、`listing_id` 和/或 `channel_type` 筛选结果范围。 - [查询订单标签](https://api-doc.myhostex.com/reference/query-reservation-tags.md): 列出房东账号的订单标签字典。包括系统默认标签(`is_default = true`,所有房东账号共享)和房东账号自己的自定义标签。这些是 `POST /reservations/{stay_code}/tags` 可以附加到订单的标签。 - [创建订单标签](https://api-doc.myhostex.com/reference/create-reservation-tag.md): 在房东账号字典中创建新的订单标签。颜色是从百居易调色板自动分配的。系统默认标签和房东账号自己的标签之间的名称必须是唯一的(将恢复具有相同名称的软删除标签)。房东账号的标签上限为 500 个。 - [删除订单标签](https://api-doc.myhostex.com/reference/delete-reservation-tag.md): 删除房东账号的自定义订单标签之一。系统默认标签 (`is_default = true`) 无法通过此 API 删除,并将返回 404。删除标签也会将其从已应用的任何订单中删除。 - [查询日历分享链接](https://api-doc.myhostex.com/reference/query-calendar-share-links.md): 列出房东账号的公共日历共享链接。每个链接都会公开每个房间 (`scope = entire`) 或选定子集 (`scope = partial`) 的只读日历(和订单列表),并且任何知道该 URL 的人都可以访问。 - [创建日历分享链接](https://api-doc.myhostex.com/reference/create-calendar-share-link.md): 创建新的公共日历共享链接。 `scope = entire` 暴露了房东账号账户中的所有房间; `scope = partial` 仅公开 `property_ids` 中列出的房间。每个操作符最多可以有一个全范围链接:当它已经存在时请求一个仅返回现有链接。 - [删除日历分享链接](https://api-doc.myhostex.com/reference/delete-calendar-share-link.md): 使日历共享链接永久失效。公共 URL 将开始向尝试打开它的任何人返回 `share link invalid` 错误。 - [鉴权](https://api-doc.myhostex.com/reference/authentication.md) - [错误码](https://api-doc.myhostex.com/reference/errors.md) - [限流](https://api-doc.myhostex.com/reference/rate-limits.md) - [支持的渠道](https://api-doc.myhostex.com/reference/supported-channels.md) - [支持的币种](https://api-doc.myhostex.com/reference/supported-currencies.md) - [使用指南](https://api-doc.myhostex.com/reference/webhook-useage-guide.md) - [事件类型](https://api-doc.myhostex.com/reference/webhook-event-types.md) - [查询 Webhook](https://api-doc.myhostex.com/reference/query-webhooks.md): 查询 Webhook,与[Webhooks 页面](https://www.myhostex.com/app/api/web-hooks)相同。 - [创建 Webhook](https://api-doc.myhostex.com/reference/create-webhook.md): 创建一个网络钩子。 - [删除 Webhook](https://api-doc.myhostex.com/reference/delete-webhook.md): 您只能删除您自己的应用程序创建的可管理的 Webhook。尝试从其他应用程序删除不可管理的 Webhook 将导致 403 错误。 - [更新 Webhook](https://api-doc.myhostex.com/reference/update-webhook.md): 更新 Webhook 的 URL 或事件订阅。您只能更新您自己的应用程序创建的 webhook。 - [概览](https://api-doc.myhostex.com/reference/oauth-overview.md) - [申请 OAuth 接入](https://api-doc.myhostex.com/reference/how-to-request-oauth-access.md) - [授权流程](https://api-doc.myhostex.com/reference/authorization-workflow.md) - [获取/刷新令牌](https://api-doc.myhostex.com/reference/obtain-token.md): 此端点用于使用各种 OAuth 2.0 授权类型获取新的访问令牌或刷新现有令牌。 - [删除/撤销令牌](https://api-doc.myhostex.com/reference/revoke-token.md): 此端点允许客户端撤销访问或刷新令牌。删除/撤销令牌将断开主机与您的应用程序的连接。 - [概览](https://api-doc.myhostex.com/reference/mcp-overview.md) - [快速开始](https://api-doc.myhostex.com/reference/mcp-quickstart.md) - [工具参考](https://api-doc.myhostex.com/reference/mcp-tools-reference.md)