# 未读消息数回调

当客服人员回复了用户的消息后,用户可以收到未读消息的提醒,即使当前并没有展示 AIHelp 的页面。

提示

此功能默认为关闭状态,如有需要,请联系 AIHelp 运营人员开启此功能。

# API

注意

AIHelp 默认使用随机生成的 deviceId 作为 userId 进行未读消息数量的轮询。

所以,在你将正确的 userId 同步给 AIHelp 之前,未读消息数量可能会不准确。

1、在接入之前,请确保你已经联系 AIHelp 运营人员开启了此功能;

2、在 init API 调用完成后,添加 message 事件的监听回调,来获取未读消息数量的数量:











 
 
 
 




<script src="https://cdn.aihelp.net/webchatv3/aihelp.js"></script>
<body>
  <script>
    (function () {
      let initConfig = {
        appKey: "THIS IS YOUR APP KEY",
        domain: "THIS IS YOUR APP DOMAIN",
        appId: "THIS IS YOUR APP ID"
      };
      AIHelpSupport.init(initConfig);
      window.addEventListener("message", function (event) {
        const { data } = event;
        // data -> { type: 'newChatCount', count: 3 }
      });
    })();
  </script>
</body>

调用 init API 后,SDK 内部会每 5 分钟主动拉取一次当前用户的未读消息数量,并在以下两种情况时将结果返回给调用者:

1、有进行中客诉的用户收到新消息时,返回该用户累计未读的消息数量;

2、用户打开客服会话窗口时,返回数字 0 以标记用户已读当前消息。

# URL

此功能不支持通过 URL 方案实现。

AIHelp 未读消息数量是基于轮询实现的,所以需要确保 AIHelp 在应用启动的时刻进行初始化,并在后台开始每五分钟一次的轮询作业。

URL 方案通过拼接链接的方式打开页面,在打开具体的 URL 链接之前,AIHelp 的代码无法得到执行,也就无法开启轮询,所以此功能不支持通过 URL 方案实现。

上次更新: 12/19/2023, 3:49:07 AM