常见问题自动回复接口

常见问题接口配置

当访客打开聊天窗口时，可以先显示一些常见问题的链接，由访客点击后自动给出回复。
如图中的三条常见问题链接，常见问题可以在客服系统设置，也可以由您的业务系统提供。当由您的业务系统提供时，可以根据访客的身份，向其展示特定的常见问题列表和内容。

注意，由于访客身份信息是通过 URL 明文传递的，所以不建议在常用问题对接时，展示访客的隐私信息，比如积分、订单等。
例如：可根据访客的身份类型等不敏感信息，展示不同的营销活动；不同的售后联系方式；不同的常见问题清单等。

点击客服系统顶部的“机器人设置”后，将模式修改为“外部接口提供”。

然后填写您的接口地址即可。

接口对接说明

当访客打开聊天窗口页面时，客服系统将自动向您的接口发送一个 POST 请求，并通过获取的返回 JSON 数据，来显示常见问题列表和内容。

客服系统请求此接口时，以 POST 方式发送如下 JSON 对象：

{
    "action":"",
    "language":"",
    "robotItemId":"",
    "externalId":"",
    "externalName":"",
    "externalData":""
}

action 可以指定以下值：

• GetRobotItemTitleList：返回顶层常见问题列表。
• GetRobotItem：根据指定的常见问题条目 Id，返回它的回复内容和下级条目（如果有）。

robotItemId 用于 GetRobotItem 这个 action，当访客点击某条常见问题时，获取对应的详细信息。

externalId 为业务系统传递到客服系统的访客唯一身份标识。参阅：传递您的访客数据到客服系统
externalName 和 externalData 为业务系统传递到客服系统的访客名称和扩展数据。

如果没有向客服系统传递自定义数据，那么 externalId，externalName，externalData 这三个参数将为空。

language 语言有以下值：

• zh-CHS：简体中文
• zh-CHT：繁体中文
• en-US：英语-美国
• ja-JP：日文-日本
• pt-PT：葡语-葡萄牙
• id-ID：印尼语-印度尼西亚
• ko-KR：韩语-韩国
• ru-RU：俄语-俄罗斯
• tr-TR：土耳其语-土耳其
• uk-UA：乌克兰语-乌克兰
• es-ES：西班牙文-西班牙

您的接口请按以下格式返回 JSON 对象：

{
    "data":null,
    "successful": true,
    "message": null
}

data： 不同 action 对应不同的返回对象。
successful：成功为 true ，失败为 false。
message：失败时可以给出一个提示信息，访客端会弹框显示此信息。

不同 action 的返回参数说明

GetRobotItemTitleList

返回顶层常见问题条目列表。
其中的 id ，由业务系统接口自行指定，在接下来获取对应的回复内容时，客服系统将在 robotItemId 参数中传递此 id。

{
    "data": 
    [
        {
        "title": "如何开始使用？",
        "id": "8ee2579b-cff5-40ca-a27c-931a9ab9d9ce"
        }, 
        {
        "title": "如何修改上面的LOGO？",
        "id": "9b35a700-a487-4327-8f93-3302b5aacf17"
        }
    ],
    "successful": true,
    "message": null
}

GetRobotItem

根据指定的机器人回复条目 Id，返回它的回复内容和下级条目。

children 是可选的，没有下级为 null 即可。
content 可以是 html 内容，比如要返回一张图片， content 中包含 img 标签即可。
content 和 children 可以同时指定。

{
    "data": 
    {
        "id": "8ee2579b-cff5-40ca-a27c-931a9ab9d9ce",
        "title": "如何开始使用？",
        "content": "下载安装客服端软件后，登录客服账户开始使用。",
        "children": 
        [
            {
                "title": "新建内容",
                "id": "5811e66d-a41a-4f12-b4d4-4965daad4d41"
            }, 
            {
                "title": "新建内容2",
                "id": "628049e9-bc62-4370-ace3-83794bae529f"
            }
        ]
    },
    "successful": true,
    "message": null
}