58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
---
|
|
name: voice-notification
|
|
description: Voice Notification - Push voice broadcast messages to active voice sessions for real-time TTS playback
|
|
---
|
|
|
|
# Voice Notification - Voice Broadcast
|
|
|
|
Push voice broadcast messages to users' active voice sessions. The message will be played via TTS when the session is in idle state.
|
|
|
|
## Quick Start
|
|
|
|
When a user requests to send a voice notification:
|
|
1. Compose the message content
|
|
2. Call voice_notify.py to send the broadcast
|
|
|
|
## Instructions
|
|
|
|
### Tool Path
|
|
|
|
```bash
|
|
python {skill_dir}/scripts/voice_notify.py broadcast --message "Your message here"
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Required | Description |
|
|
|-----------|----------|-------------|
|
|
| `--message` | Yes | The message content to be spoken via TTS |
|
|
|
|
### Response
|
|
|
|
- Success: `{"success": true, "queued": true}`
|
|
- Error: `{"success": false, "error": "..."}`
|
|
|
|
## Examples
|
|
|
|
**User**: "Send a voice notification: the meeting is starting"
|
|
|
|
```bash
|
|
python {skill_dir}/scripts/voice_notify.py broadcast \
|
|
--message "The meeting is starting soon, please get ready"
|
|
```
|
|
|
|
**User**: "Notify me via voice that my coffee is ready"
|
|
|
|
```bash
|
|
python {skill_dir}/scripts/voice_notify.py broadcast \
|
|
--message "Your coffee is ready, please come pick it up"
|
|
```
|
|
|
|
## Guidelines
|
|
|
|
- The target user must have an active voice session connected to `/api/v3/voice/realtime`
|
|
- The voice session must be in lite mode (`voice_mode: "lite"`)
|
|
- Messages are queued and played when the session enters idle state
|
|
- Keep messages concise for better TTS experience
|
|
- Message language should match the user's preferred language
|