有多种方法可将内容从一个帮助中心迁移到另一个。本文章主要介绍使用帮助中心 API 以编程方式导入内容,并简要概述将现有内容迁移到新的帮助中心知识库和社区的过程。您也可以使用以下方法迁移内容:
- 复制/粘贴 —— 如果您只是迁移几篇文章,那么最快、最简单的方法就是从以前的帮助中心复制并粘贴内容到新的 Guide 文章中。
- 专业服务 —— 如果您有大型或复杂的迁移,您可以 聘请 Zendesk 帮助 您进行迁移。
- 合作伙伴应用 —— 您可以探索 Zendesk 应用市场 以查找合作伙伴应用,例如 服务台迁移。
本文涵盖以下主题:
将内容迁移到您的知识库
将内容从外部系统迁移到帮助中心是一个多步骤的过程,后续步骤需要来自一个步骤的数据。
规划至关重要。您需要将旧版内容的结构映射到帮助中心的三层结构:
将您的作者导入为 Zendesk 用户
首先,您必须以“专员”用户角色导入所有文章的作者(Zendesk 中的专员不一定是解决工单的人(请参阅 了解 Zendesk Support 用户角色)。
使用 API 创建 Zendesk 用户(请参阅 创建用户)。确保您将 role
在每个 POST 请求中将属性设置为“agent”。
成功创建用户后,Zendesk 在 JSON 响应中返回用户详情,包括用户的新 ID:
{
"user": {
"id": 9873843,
"name": "Roger Wilco",
...
}
}
记录每个用户的 ID,因为您需要这些 ID 来设置 author_id
您在帮助中心创建的每篇文章的属性。
如果您计划将 用户区段 中的 组织 用于隔离组别,则必须先创建组织 ,然后 再创建任何用户。然后,您可以在创建用户时将组织 ID 分配给该用户(请参阅 创建组织)。如果您的用户将属于多个组织,则使用 组织成员 将组织添加到用户记录。
在知识库中创建类别
类别是组别的集合(请参阅 创建类别)。创建类别后,Zendesk 会返回带有该类别新 ID 的 JSON 响应:
{
"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 返回带有用户区段新 ID 的 JSON 响应:
{
"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 来为组别分配访问限制。
在您的类别中创建组别
组别是文章的集合(请参阅 创建组别)。确保您将 category_id
和 user_segment_id
(如果有的话),在每个 POST 请求中。Zendesk 返回带有组别新 ID 的 JSON 响应:
{
"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
,请确保您已将 author_id
和 section_id
在每个 POST 请求中。
Zendesk 返回如下所示的 JSON 响应:
{
"article": {
"id": 37486578,
"author_id": 3465,
"promoted": false,
"position": 42,
"comments_disabled": true,
"section_id": 98838,
...
}
}
上传附件(如有必要)
如果文章包含未托管在公开文件服务器(例如 Amazon S3)上的内嵌图像,则将图像上传到您的帮助中心(请参阅 创建未关联的附件)。确保您将 inline
参数为 true
。
Zendesk 返回带有 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 来分配访问限制到主题。
导入社区中的主题
如果适用,请确保您将 user_segment_id
在 POST 请求中(请参阅 创建主题)。
Zendesk 返回带有主题 ID 的 JSON 响应:
{
"topic": {
"id": 115000553548,
"name": "Help Center-Tricks",
...
}
}
记录每个主题的 ID,因为当您稍后创建主题时,您将需要主题 ID 来将帖子分配到特定的主题。
导入主题中的帖子
除了 title
和 details
,请确保您已将 author_id
和 topic_id
在每个 POST 请求中(请参阅 创建帖子)。
与知识库文章不同,社区帖子的作者可以是专员或终端用户。
当创建帖子时,作者将自动订阅该主题的所有更新,并在创建或更新新帖子时得到通知。
当帖子创建时,同一主题的所有订阅者都会收到一封电邮通知。为了避免订阅者在批量导入帖子时被通知淹没,请在 notify_subscribers
参数,值为 false
在您的 POST 请求中。
{
"post": {
"id": 35467,
"author_id": 89567,
"title": "Help!",
"details": "My printer is on fire!",
"notify_subscribers": false,
...
}
}
导入帖子中的评论
创建帖子并获取其 ID 后,您现在可以添加其关联评论(请参阅 创建评论)。
您一次只能创建一条评论。当创建帖子评论时,评论作者将自动订阅该主题的所有更新,并在创建或更新新帖子时得到通知。
当评论创建时,同一主题的所有订阅者都会收到电邮通知。为了避免订阅者被通知淹没,请添加 notify_subscribers
参数,值为 false
在您的 POST 请求中。
翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性
如对翻译准确性有任何疑问,请以文章的英语版本为准。