将现有内容迁移到帮助中心

What's my plan?

Suite

Any plan

Support with

Guide, any plan

可通过多种方式将内容从一个帮助中心迁移到另一个。本文章主要介绍如何使用帮助中心 API 以编程方式导入内容，概述了将现有内容迁移到新的帮助中心的过程。您还可以使用以下方法迁移内容：

• 复制粘贴：如果您仅迁移几篇文章，那么最快速、最简单的方法是将内容从以前的帮助中心复制粘贴到新的文章中。
• 专业服务：如果您要进行大型或复杂的迁移，可以聘请 Zendesk 帮助您进行迁移。
• 合作伙伴应用：您可以探索 Zendesk 应用市场查找合作伙伴应用，例如服务台迁移。

本文章涵盖以下主题：

• 将内容迁移到知识库
  • 导入作为 Zendesk 用户的作者
  • 在知识库中创建类别
  • 创建用户区段（可选）
  • 在类别中创建组别
  • 在组别中创建文章
  • 上传附件（如需要）
  • 正在导入文章评论
• 将内容迁移到社区
  • 创建用户区段（可选）
  • 导入社区中的主题
  • 导入主题中的帖子
  • 导入帖子中的评论

将内容迁移到知识库

将内容从外部系统迁移到帮助中心是一个多步骤的过程，其中一个步骤中的数据要用于后续步骤。

规划至关重要。您要将旧版内容的结构映射到帮助中心的三层结构：

导入作为 Zendesk 用户的作者

首先，您必须将所有文章的作者导入为用户角色为“专员”的 Zendesk 用户。Zendesk 中的专员不一定是解决工单的人，请参阅了解 Zendesk Support 用户角色）。

使用 API 创建 Zendesk 用户（请参阅创建用户）。确保您已在每个 POST 请求中将 role 属性设为“agent”。

成功创建用户后，Zendesk 将在 JSON 响应中返回用户详情，包括用户的新 ID：

{
  "user": {
    "id":   9873843,
    "name": "Roger Wilco",
    ...
  }
}

记录每个用户的 ID，因为您需要使用这些 ID 设置在帮助中心创建的每篇文章的 author_id 属性。

提示：您可能需要为每个作者 ID 及其旧版文章创建一个映射。

如果您计划使用用户区段中的组织来隔离组别，则必须在创建用户之前创建组织。然后，您可以在创建用户时为用户分配组织 ID（请参阅创建组织）。如果您的用户属于多个组织，则使用组织成员身份将组织添加到用户记录。

在知识库中创建类别

类别是组别集合（请参阅创建类别）。在您创建类别后，Zendesk 将返回一个 JSON 响应，带有该类别的新 ID：

{
  "category": {
    "id":          37486578,
    "name":        "Super Hero Tricks",
    "description": "This category contains a collection of Super Hero tricks",
    "locale":      "en-us",
    "position":    2,
    ...
  }
}

记录每个类别的 ID，因为稍后创建组别时，需要使用这些 ID 将组别分配到特定的类别。

创建用户区段（可选）

如果您想限制对帮助中心某些组别的访问，可以将用户区段分配到您的组别（请参阅创建用户区段）。

在您创建用户区段后，Zendesk 将返回一个 JSON 响应，其中包含该用户区段的新 ID：

{
  "user_segment": {
    "id": 7284
    "name": "VIP agents",
    "user_type": "staff",
    "group_ids": [12, ...],
    "organization_ids": [42, ...],
    "tags": ["vip"],
    "created_at": "2017-05-21T20:01:12Z",
    "updated_at": "2017-05-21T20:01:12Z",
    "built_in": false
  }
}

记录每个用户区段的 ID，因为稍后当您创建组别时，您将需要该区段 ID 来分配访问限制到这些组别。

在类别中创建组别

组别是文章的集合（请参阅创建组别）。确保您已在每个 POST 请求中设置 category_id 和 user_segment_id（如有）。Zendesk 返回一个 JSON 响应，附带该组的新 ID：

{
  "section": {
    "id":          3457836,
    "name":        "Avionics",
    "description": "This section contains articles on flight instruments",
    "locale":      "en-us",
    "category_id": 3465,
    ...
  }
}

记录每个组别 ID，因为稍后创建文章时，需使用组别 ID 将文章分配到特定组别。

在组别中创建文章

获得了上述步骤中的所有组别 ID 和用户 ID 后，即可创建文章（请参阅创建文章）。除了 title 和 body，请确保您已在每个 POST 请求中设置 author_id 和 section_id。

注意：所有作者都将自动订阅其文章。如果您的帮助中心已激活，那么作者将在文章创建时收到一封电邮通知。

Zendesk 返回的 JSON 响应如下所示：

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    "section_id":        98838,
    ...
  }
}

上传附件（如需要）

如果文章包含未托管在公共文件服务器（例如 Amazon S3）上的内嵌图像，则请将图像上传到您的帮助中心（请参阅创建未关联附件）。确保您已将 inline 参数设为 true。

Zendesk 将返回 JSON 响应及附件 URL (content_url)：

{
  "article_attachment": {
    "id":           1428,
    "article_id":   null,
    "file_name":    "icon.jpg",
    "content_url":  "https://company.zendesk.com/hc/article_attachments/1428/icon.jpg",
    "content_type": "application/image",
    "size":         58298,
    "inline":       true
  }
}

使用 content_url 以更新文章 HTML 中的图像 URL（请参阅将批量附件关联到文章）。

正在导入文章评论

要导入评论，则需输入作者 ID 和文章的 ID。专员和终端用户都可以是评论的作者（请参阅创建评论）。

注意：评论作者会自动订阅该文章。如果您的帮助中心已激活，他们会在评论创建后收到一封电邮通知。

将内容迁移到社区

导入社区内容与导入知识库有诸多相似的注意事项。您需要导入用户，以便将作者分配给帖子。您还要将旧版社区内容的结构映射到帮助中心社区的两层结构：

创建用户区段（可选）

如果您想限制对某些主题的访问，则需要输入用户区段ID（请参阅创建用户区段）。稍后创建主题时，您要通过用户区段 ID 向主题分配访问限制。

导入社区中的主题

如适用，请确保您已在 POST 请求中设置 user_segment_id（请参阅创建主题）。

Zendesk 返回一个 JSON 响应及主题 ID：

{
  "topic": {
    "id":   115000553548,
    "name": "Help Center-Tricks",
    ...
  }
}

记录每个主题的 ID，因为稍后创建主题时，需要使用主题 ID 将帖子分配到特定的主题。

导入主题中的帖子

除了 title 和 details，请确保您已在每个 POST 请求中设置 author_id 和 topic_id（请参阅创建帖子）。

与知识库文章不同，社区帖子的作者可以是专员或终端用户。

创建帖子时，作者将自动订阅该主题的所有更新，并收到新建帖子或更新帖子的通知。

创建帖子时，相同主题的所有订阅者都会收到电邮通知。为避免订阅者在批量导入帖子时收到大批量通知，在 POST 请求中包含值为 false 的参数 notify_subscribers。

{
  "post": {
    "id":        35467,
    "author_id": 89567,
    "title":     "Help!",
    "details":   "My printer is on fire!",
    "notify_subscribers": false,
    ...
  }
}

导入帖子中的评论

创建帖子并获取其 ID 后，即可添加关联评论（请参阅创建评论）。

您一次只能创建一条评论。创建帖子评论时，评论者将自动订阅该主题的所有更新，并收到新建帖子或更新帖子的通知。

创建评论时，相同主题的所有订阅者都会收到电邮通知。为避免订阅者收到大批量通知，在 POST 请求中包含值为 false 的参数 notify_subscribers。