聊天小部件

嵌入您网站的聊天小部件所使用的所有端点。

聊天小部件将您的聊天机器人嵌入到您的网站中。此分组描述小部件所使用的所有端点:可用性检查、公开小部件配置、发送消息、对话历史、获取新消息(例如在客服接管对话之后)、评价、使用事件,以及语音输入和输出。

为使小部件能在浏览器中初始化,`health` 和 `config` 可在无需身份验证的情况下调用。其余所有端点均要求在 `X-Widget-Token` 请求头中提供小部件的 `widget_code` 和嵌入令牌。Zentor 会在设置时创建该小部件,存储已批准的域名,并为您提供包含小部件代码和嵌入令牌的嵌入代码。服务器会以 403 `WIDGET_ORIGIN_DENIED` 拒绝来自未获批准域名的调用,并以 404 `WIDGET_DISABLED` 响应已停用小部件的调用。

此外,您账户的访问规则(IP、国家和域名规则)同样适用。`message` 不是幂等的:每次重新发送都会产生另一条消息和另一个回复。

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← API 参考