Zendesk Chat组件状态监测：需实现服务故障时通知站点所有者

Great question! The core problem with $zopim.livechat.setOnStatus() is that it only returns a generic "online/offline" status—this doesn’t tell you if the chat is offline because agents are signed out, or because Zendesk’s servers are down. Here’s a practical, multi-layered approach to solve this:

1. Monitor Zendesk Chat Script Load Failures #

If Zendesk’s servers are down, the initial chat script might fail to load entirely. You can catch this by dynamically loading the script and listening for error events:

// Dynamically load Zendesk Chat script and watch for load failures
const zendeskChatScript = document.createElement('script');
zendeskChatScript.src = 'https://v2.zopim.com/?YOUR_UNIQUE_ACCOUNT_KEY';
zendeskChatScript.async = true;

// Trigger alert if script fails to load
zendeskChatScript.addEventListener('error', () => {
  notifySiteOwner('Zendesk Chat failed to load—likely a server outage.');
});

document.body.appendChild(zendeskChatScript);

2. Combine Status Updates with Heartbeat Checks #

Even if the script loads initially, Zendesk’s service could go down later. Use a heartbeat check to verify connectivity, and cross-reference it with the status callback to rule out agent-initiated offline status:

let lastKnownChatStatus = null;
let heartbeatInterval;

// Track initial chat status changes
$zopim.livechat.setOnStatus((status) => {
  lastKnownChatStatus = status;
});

// Heartbeat function to validate service availability
function checkZendeskServiceHealth() {
  try {
    // Attempt to fetch current chat status (will throw error if service is down)
    const currentStatus = $zopim.livechat.getStatus();

    // If status suddenly switches from online to offline, verify it's not just agents signing out
    if (currentStatus === 'offline' && lastKnownChatStatus === 'online') {
      // Test access to a static Zendesk resource to confirm server connectivity
      const testResource = new Image();
      testResource.onerror = () => {
        notifySiteOwner('Zendesk Chat went offline and static resources are unreachable—possible server outage.');
      };
      testResource.src = 'https://v2.zopim.com/static/images/zopim-logo.svg';
    }
  } catch (err) {
    // If calling Zendesk methods throws an error, the service is unresponsive
    notifySiteOwner('Zendesk Chat is unresponsive—cannot access core chat functions.');
    clearInterval(heartbeatInterval); // Stop heartbeat to avoid duplicate alerts
  }
}

// Start heartbeat check every 5 minutes (adjust interval as needed)
heartbeatInterval = setInterval(checkZendeskServiceHealth, 5 * 60 * 1000);

3. Implement the Owner Notification Function #

Create a helper function to send alerts to your site owners—this can integrate with email, Slack, or your internal alerting system:

function notifySiteOwner(alertMessage) {
  // Replace this with your preferred notification logic
  fetch('/your-backend-alert-endpoint', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      message: `Zendesk Chat Alert: ${alertMessage}`,
      timestamp: new Date().toISOString(),
      siteUrl: window.location.href
    })
  });
}

Key Notes #

• Adjust the heartbeat interval based on how quickly you need to detect outages (shorter intervals = more frequent checks, but slightly more resource usage).
• The static resource check helps confirm whether the outage is on Zendesk’s end (resource fails to load) vs. just agents being offline (resource loads fine).

内容的提问来源于stack exchange，提问作者Neeraj Mahajan