使用 Web API 配置对话自动关闭

本文演示了如何使用 Web API 配置对话的自动关闭持续时间。

重要

配置为统一传递的记录不支持基于持续时间的对话自动结束。 当您删除路由记录时,关联的队列项将被删除。 实时工作项或对话也将作为清理过程的一部分被删除。

使用以下GET请求获取所有出厂预定义的配置记录。

请求

GET [Organization URI]/api/data/v9.1/msdyn_occhannelstateconfigurations
Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

响应

{ 
   "@odata.context":"[Organization URI]/api/data/v9.1/$metadata#msdyn_occhannelstateconfigurations",
   "value":[ 
      { 
         "@odata.etag":"W/\"1379367\"",
         "_organizationid_value":"11bb11bb-cc22-dd33-ee44-55ff55ff55ff",
         "msdyn_name":"Live Chat - Open",
         "statecode":0,
         "statuscode":1,
         "_msdyn_occhannelconfigurationid_value":"836717fd-5578-e911-8196-000d3af7d71e",
         "msdyn_autocloseliveworkitemafter":20,
         "modifiedon":"2019-10-01T13:41:51Z",
         "_modifiedby_value":"d6e088ce-8866-4b3d-8ea2-150ad72e2b79",
         "msdyn_ocliveworkitemstate":0,
         "msdyn_showconfirmationonsessionclose":false,
         "versionnumber":1379367,
         "msdyn_occhannelstateconfigurationid":"6283ab63-5778-e911-8196-000d3af7d71e",
         "createdon":"2019-10-01T13:41:51Z",
         "_createdby_value":"d6e088ce-8866-4b3d-8ea2-150ad72e2b79",
         "_modifiedonbehalfby_value":null,
         "importsequencenumber":null,
         "overriddencreatedon":null,
         "_createdonbehalfby_value":null,
         "utcconversiontimezonecode":null,
         "timezoneruleversionnumber":null
      },
      { 
         "@odata.etag":"W/\"1379368\"",
         "_organizationid_value":"11bb11bb-cc22-dd33-ee44-55ff55ff55ff",
         "msdyn_name":"Live Chat - Active",
         "statecode":0,
         "statuscode":1,
         "_msdyn_occhannelconfigurationid_value":"836717fd-5578-e911-8196-000d3af7d71e",
         "msdyn_autocloseliveworkitemafter":null,
         "modifiedon":"2019-10-01T13:41:51Z",
         "_modifiedby_value":"d6e088ce-8866-4b3d-8ea2-150ad72e2b79",
         "msdyn_ocliveworkitemstate":1,
         "msdyn_showconfirmationonsessionclose":true,
         "versionnumber":1379368,
         "msdyn_occhannelstateconfigurationid":"e2737c9a-5778-e911-8196-000d3af7d71e",
         "createdon":"2019-10-01T13:41:51Z",
         "_createdby_value":"d6e088ce-8866-4b3d-8ea2-150ad72e2b79",
         "_modifiedonbehalfby_value":null,
         "importsequencenumber":null,
         "overriddencreatedon":null,
         "_createdonbehalfby_value":null,
         "utcconversiontimezonecode":null,
         "timezoneruleversionnumber":null
      },
   ]
}

msdyn_name实体中的msdyn_occhannelstateconfiguration属性提及聊天的频道和状态。 有关对话状态的详细信息,请参阅 了解 Customer Service 全渠道中的对话状态

您可以向msdyn_occhannelconfiguration实体发出GET请求以获取所有现有渠道记录。 对于其中每个通道,您可以在查询 msdyn_occhannelstateconfiguration 实体时查看其状态。

msdyn_occhannelstateconfiguration实体记录发出PATCH请求并更新msdyn_autocloseliveworkitemafter属性的值。

PATCH [Organization URI]/api/data/v9.1/msdyn_occhannelstateconfigurations(6283ab63-5778-e911-8196-000d3af7d71e)
Accept: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-None-Match: null

{
    "msdyn_autocloseliveworkitemafter":5
}

以下是更新实体中 msdyn_occhannelstateconfigurations 现有记录的示例代码:

var data =
    {
        "msdyn_autocloseliveworkitemafter": 2
    }
// update the record
Xrm.WebApi.updateRecord("msdyn_occhannelstateconfiguration", "6283ab63-5778-e911-8196-000d3af7d71e", data).then(
    function success(result) {
        console.log("Auto close time updated");
    },
    function (error) {
        console.log(error.message);
    }
);

注释

msdyn_autocloseliveworkitemafter 属性的值以分钟为单位。 如果要提供以天为单位的值,则必须将其转换为分钟。 例如,1 天是 24 x 60 = 1440 分钟。

如果属性的值 msdyn_autocloseliveworkitemafter 大于 createdon 属性的值,会话将自动关闭。

如果对话处于话后状态,即客户服务代表(服务代表或代表)已经解决了问题,现在可以执行一些对话后步骤来结束对话,则当属性的值 msdyn_autocloseliveworkitemafter 大于 wrapupinitiatedon 属性的值时,对话将关闭。

重要

根据 msdyn_autocloseliveworkitemaftercreatedon 属性的值关闭对话的决定是在计划作业运行时做出的,而不是在运行 PATCH Web API 请求时做出的。

为实时聊天配置自动关闭总结状态

自动关闭处于 Wrap-up (总结 ) 状态的实时聊天的默认时间为 15 分钟。 该值在 attribute 中 msdyn_autocloseliveworkitemafter 定义,并且可以通过编程方式进行更改以满足您的业务需求。

在工作流中,如果为收尾块容量字段定义的值高于msdyn_autocloseliveworkitemafter属性的值,则该值将覆盖msdyn_autocloseliveworkitemafter属性中指定的值。 例如,如果您已将阻止代表容量的值设置为 15 分钟,并将 msdyn_autocloseliveworkitemafter 属性设置为 10 分钟,那么处于 总结 状态的对话将占用15分钟的容量,并且只有在15分钟后才有资格自动关闭。

后续步骤

使用 Web API 更新实体

自动关闭对话