外部学习模块最佳实践

本文列出了使中间件与 Genesys API 交互的最佳实践。

Genesys Cloud 可以将 Genesys Cloud 平台外部的系统同步到 Genesys 学习模块。

描述

要创建学习模块,管理员可以使用以下端点:

POST /learning/modules

指令

外部模块必须是指向外部学习资源的单个 URL。

示例

{
"name": "SMART goals",
"description": "This external training takes you through how to create SMART goals.",
"completionTimeInDays": 14,
"informSteps": [
{
"type": "Url",
"name": "SMART goals",
"order": 1,
"value": "https://myLms.com/courses/1234"
}
],
"excludedFromCatalog": true,
"externalId": "1234",
"type": "External"
}

描述

要发布学习模块,管理员可以使用以下端点:

POST /api/v2/learning/modules/{moduleId}/publish 

指令

如果您在发布后编辑学习模块,则必须再次重新发布该模块才能将更新版本的模块分配给用户。 您可以从目录中隐藏模块,以防止当主管通过工作区开发页面分配学习模块时它们显示在模块列表中。

描述

管理员可以使用以下方法分配学习模块终点:

POST /api/v2/learning/assignments 

指令

您可以向用户分配特定版本的学习模块。 学习模块的版本仅在用户开始作业时确定。 如果用户尚未开始分配并且发布了较新版本的模块,则最新版本的学习模块会自动分配给该用户。

示例

{
"moduleId": "2169a726-31e1-4d69-b161-1b62ccb1c99e",
"userId": "1e39d64f-68ff-41cc-8a2e-781cbce08409",
"recommendedCompletionDate": "2024-02-01T15:00:00Z",
"lengthInMinutes": "60"

}

注意: RecommendedCompletionDate 和 lengthInMinutes 是可选覆盖。 如果您不提供RecommendedCompletionDate 和lengthInMinutes,则它们的值基于模块中的值。

描述

您可以从 Genesys Cloud 启动学习模块。 在作业启动期间,会出现一个带有模块描述和封面艺术的封面屏幕。 

指令

当您单击开始作业时,您将被重定向到模块步骤中指向外部学习资源的 URL

描述

要更新作业,外部系统必须通过以下方式将学习资源的结果发送到 Genesys Cloud:终点:

PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments 

指令

下列端点受到限制学习:外部作业:编辑默认情况下未分配给任何角色的权限:

PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments 

该端点始终更新该用户和学习模块的最新作业。

示例

{
"state": "Completed",
"percentageScore": 85,
"isPassed": true
}

注意: 如果您对如何创建中间件有疑问,Genesys 建议您联系您的合作伙伴或客户服务部门。