1. Notification Parameters
  2. Sound Notification

Notification Parameters

Sound Notification

How to play a notification sound in the webchat client

Trigger an audible notification on the webchat client by sending a _stubber_webchat_status_sound control event. The sound_name parameter selects which sound is played.

        {
  "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

To play a specific sound, set sound_name to one of the values above. For example, 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"
        }
      }
    }
  }
}