What's my plan?
Suite Growth, Professional, Enterprise, or Enterprise Plus

操作是您配置的自动任务。这些操作可以通过 自动协助(是 专员 Copilot的一部分)和 操作流程(执行一系列预定义的自动任务)执行。

本文章包含以下主题:

  • 创建操作的最佳实践
  • 创建外部操作
  • 测试操作
  • 后续步骤

相关文章:

  • 关于自动协助和操作流程的操作
  • 管理自动协助和操作流程的操作

创建操作的最佳实践

创建操作时,请遵循以下最佳实践:

  • 使用连接进行身份验证。请勿在操作配置中包含身份验证凭证。而应使用连接 ,因为这些连接专用于确保您敏感详情的安全。
  • 请注意访问权限。请记住,连接可能比您的专员或终端用户具有更高的访问权限。配置您的操作、 程序和专员培训,避免将敏感数据共享给错误的受众。
  • 尽可能确保数据的私密性。在捕获部分操作响应作为输出时,请注意仅捕获您需要的特定数据点。捕获与手头任务不直接相关的数据并非良好的隐私保护实践,此外,可能会对自动协助产生混淆。
  • 为操作、输入和输出撰写合适的名称和描述。名称和描述有助于自动协助确定操作(包括其输入和输出)何时与客户请求相关。此外,如果您对现有操作进行更改,请确保名称和描述仍然准确。

    名称和描述必须清楚描述操作的含义和结果。例如:

    • 操作名称:将图书添加到购物车
    • 操作描述:添加一本书到客户的购物车。

    在自动协助程序中引用操作时,请使用相似的语言来引用特定操作。

    • 例如:“在客户确认要购买的电子书后,将其添加到购物车。”
  • 规划缺失的输入。如果输入有时可用,请确保您的描述说明了应如何处理该情况。例如,并非每个请求者都有电邮地址。因此,对于名为 requester_email_address 的输入,您可能会说:“发起工单的终端用户的电邮地址。如果这不可用,请填写“不可用”。
  • 明确区分操作流程和操作流程的名称和描述 如果同时使用操作和操作流程,则明确区分二者使用的名称和描述非常重要。虽然操作和操作流程在管理中心的不同部分进行管理,自动协助仍会看到这两者,并认为它们是等效的。

    例如,如果您有一个名为“订单退款”的操作和一个名为“订单退款”的操作流程,则描述需要足够详细,以区分它们。如果两者的描述都含糊不清,自动协助可能会建议错误的描述,或两者兼顾。

操作限制

以下限制适用于操作:

  • 每个帐户最多可进行 100 项操作。
  • 每个操作最多有 100 个输入和 100 个输出。
  • 外部操作的超时为 10 秒钟。如果外部系统响应时间超过 10 秒钟,或您的 Zendesk 帐户未能收到响应,则操作不会执行。
  • 外部操作的最大响应大小为 2MB。
  • 2025 年 3 月 13 日之前创建的操作必须在更新并保存后才能在操作流程中用作操作流程。

创建外部操作

管理员可在管理中心创建新的外部操作。外部操作需要输入、API 调用和输出。

  • 输入 是操作运行所使用的信息。您定义的每个输入都会创建一个输入占位符,可以插入到操作的 URL、正文、查询参数或标头中。

    自动协助在执行操作时会用数据替换这些占位符。在操作流程中,占位符可用于操作流程步骤的各种属性。

  • API 调用 是指信息在发送到 API 时应具有的确切结构。
  • 输出 决定了 Zendesk 如何解释 API 返回的数据。您定义的输出会告诉操作在执行操作时将 API 响应的哪些部分发送回自动协助。

创建外部操作

  1. 在 管理中心,单击 应用和整合 ,然后选择 操作 > 操作。
  2. 单击 创建操作。
  3. 在 名称 字段中,输入操作的描述性名称。

    此名称向专员显示,并显示在活动日志中。

  4. 在 描述 字段中,输入操作的描述。

    系统使用此描述来确定何时应将操作与 自动协助结合使用。如需帮助撰写良好的描述,请参阅 创建操作的最佳实践。

  5. 在 输入 部分,单击 添加输入。
    1. 在 添加输入 窗口中,填写以下字段:
      • 名称:为输入输入一个描述性名称。
      • 描述:输入输入的描述。
      • 类型:从以下选项中进行选择:字符串、 整数、 小数或 布尔值。
        严格执行输入类型。例如,整数 3.0 将不被接受,布尔值字符串“true”将不被接受,布尔值 false 将不被接受字符串。
    2. 单击 添加输入。
  6. 在 API 配置 面板中,填写以下字段:
    1. 请求方法:根据您希望操作的目的,选择 GET、POST、PATCH、PUT或 DELETE。
    2. 端点 URL:输入您的外部服务的 URL。

      仅允许 https:// URL。

    3. 身份验证:选择现有的 API 连接。
    4. 正文:输入您在此 API 调用中请求的信息。

      要为您创建的任何输入插入占位符,单击 {+} 并选择合适的输入。

    5. 查询参数:单击 添加参数 ,并为应用于此 API 调用的任意参数添加 键 和 值 。
    6. 页首:单击 添加标头 ,并为应用到此 API 调用的所有标头添加 名称 和 值 。

      您无需添加内容类型标头。仅支持 Application/json 值,并在进行 API 调用时自动添加此标头。

  7. 在 输出 部分,单击 添加输出。
    1. 在 添加输出 窗口中,为您配置的每个输入输入测试数据。
    2. 单击进行 API 调用。

      此信息将发送到您的外部服务,后者会返回代表回复。

      注意:外部操作运行时,响应必须为 JSON,并具有适当的 JSON 标头(content-type:application/json)。当前不支持其他与 JSON 兼容的内容类型(例如 vnd.oracle.resource+json 或 vnd.api+json)。
    3. 在 输出 标签上,从响应中找到适当的输出,然后单击 添加。

      您可以单击 响应正文 标签,查看实际响应的格式。

    4. 输入输出的 名称 和 描述 ,然后单击 添加输出。
    5. 根据需要重复此操作,以捕获您要返回到自动协助的所有输出。
    6. 单击完成。

      如果在执行操作时响应中未包含映射的输出,该操作仍会成功,但会在发送回自动协助的响应中省略输出的键。

  8. 单击保存。

测试操作

在创建操作时,您应该对其进行测试,以确保其如预期运行。如有必要,请使用不同的输入值运行多个会产生不同响应的测试,以测试所有可能的输出。

测试操作的步骤

  1. 在 管理中心,单击 应用和整合 ,然后选择 操作 > 操作。
  2. 对于您要编辑的操作,单击选项菜单 (),然后选择 测试。
  3. 在 测试 标签的 输入 部分,为您配置的每个输入输入测试数据。
  4. 单击 进行 API 调用。

    此信息将发送到您的外部服务,后者会返回代表回复。

  5. 在 输出 部分,验证响应是否包含您预期的信息。

如果您在测试期间遇到问题,可参考以下故障排除建议:

  • 如果您使用外部操作与外部系统交互,该产品的文档是详细排除故障的最佳来源。
  • 有关测试期间可能遇到的 HTTP 错误代码的概览,请参阅 HTTP 响应状态代码。
  • 确保所有输入和输出的数据类型(整数、小数、字符串或布尔值)都适合您的用例。
  • 您可在 整合日志中查看更多关于操作执行的详情。

后续步骤

创建并测试操作后,您可以进行以下操作:
  • 在创建自动协助程序时插入操作
  • 在创建操作流程时将操作添加为步骤
  • 管理您的自定义操作

翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性

如对翻译准确性有任何疑问,请以文章的英语版本为准。

由 Zendesk 提供技术支持
OSZAR »