1. Notification Parameters
  2. Sound Notification

Notification Parameters

Sound Notification

Explains how to trigger an audible notification on the Webchat client by sending a sound control event. Useful for alerting users with preset sounds such as quick, cheerful, dingdong, and buzz.

Send a _stubber_webchat_status_sound control event. The sound_name parameter selects the sound.

        {
  "platforms": {
    "webchat": {
      "sessionuuid": "~~stub.data._incoming_webchat_data.sessionuuid",
      "webchat_control_event": {
        "action": "_stubber_webchat_status_sound",
        "params": {
          "sound_name": "~~stubpost.data.sound"
        }
      },
      "stubsession": {
        "set_new_with_timeout_hours": 24
      }
    }
  }
}

Sound Options

sound_name accepts one of the following values. Use the players to preview each sound.

Sound Preview
quick
highlow
cheerful
magic
dingdong
smile
buzz

Example

Set sound_name to one of the values above. To play the cheerful sound:

        {
  "platforms": {
    "webchat": {
      "sessionuuid": "~~stub.data._incoming_webchat_data.sessionuuid",
      "webchat_control_event": {
        "action": "_stubber_webchat_status_sound",
        "params": {
          "sound_name": "cheerful"
        }
      }
    }
  }
}
Previous <- Client Settings
Next Heimdall Routing ->