docs: add complete examples for status broadcast (text, image, video, audio, reshare)#2634
Conversation
… audio, reshare) - Add separate examples for text, image, video, and audio status - Document that audio status requires ptt:true + backgroundColor in options to be visible on mobile (without it, only shows on WA Web) - Document canBeReshared: true via contextInfo.featureEligibilities for enabling reshare button (field discovered in WAProto/WAProto.proto ContextInfo message) - Note that audio statuses cannot be reshared (WA platform restriction) with workaround: wrap audio in video with black background via ffmpeg - Use 'status@broadcast' explicitly in examples instead of generic 'jid' Closes WhiskeySockets#2633
|
Thanks for opening this pull request and contributing to the project! The next step is for the maintainers to review your changes. If everything looks good, it will be approved and merged into the main branch. In the meantime, anyone in the community is encouraged to test this pull request and provide feedback. ✅ How to confirm it worksIf you’ve tested this PR, please comment below with: This helps us speed up the review and merge process. 📦 To test this PR locally:If you encounter any issues or have feedback, feel free to comment as well. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe Broadcast Lists & Stories documentation section is expanded from a single image example to comprehensive examples covering text, image, video, and audio statuses. Audio status prerequisites ( ChangesBroadcast Lists & Stories Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 1249: The README example uses fs.readFileSync('./audio.ogg') but doesn't
import fs; update the example so it is consistent with other examples by either
adding an explicit import (e.g., add an import statement for fs) or by changing
the audio payload to the URL-style format used by images/videos (e.g., use {
url: './audio.ogg' }) so the referenced symbol fs.readFileSync is no longer
undefined.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 issues found across 1 file
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
- Replace fs.readFileSync with { url } syntax for consistency with
image/video examples; add inline comment showing Buffer alternative
- Clarify that statusJidList is required for stories (status@broadcast)
but not for broadcast lists which use their own JID format
Addresses bot review feedback on PR WhiskeySockets#2634
2 participants
Summary
Expands the "Broadcast Lists & Stories" section in the README with complete, verified working examples for all supported status types.
Closes #2633
What's changed
The existing section only showed one image example and mentioned (without code) that voice/video were supported. This PR adds:
✅ Text status example
With
backgroundColorandfontoptions documented.✅ Image status with caption
Using
status@broadcastexplicitly as JID (was using genericjidbefore).✅ Video status with caption + reshare
Documents
contextInfo.featureEligibilities.canBeReshared: true— a field defined inWAProto/WAProto.proto(ContextInfo.FeatureEligibilities, field 4) that enables the reshare button for recipients. This was completely undocumented and is not mentioned anywhere in the README or baileys.wiki.✅ Audio/voice status — critical mobile visibility fix
Documents that both
ptt: trueANDbackgroundColorare required in the options for audio status to be visible on mobile devices. Without these, the status appears on WhatsApp Web but is silently invisible on Android/iOS. The root cause is referenced insrc/Utils/messages.js("computed backgroundColor audio status" comment).✅ Audio reshare limitation + workaround
Documents that audio statuses cannot be reshared (WA platform restriction), with an
ffmpegworkaround to wrap audio in a black-background video for reshare support.Verification
All behaviors verified by sending real status updates (Baileys v7.0.0-rc.9) and confirming receipt/visibility on physical Android devices. The
canBeResharedfield was discovered by readingWAProto/WAProto.protodirectly.Summary by cubic
Adds complete, working examples for sending status updates (text, image, video, audio) via
sendMessagetostatus@broadcast, with clear options and reshare behavior that work on web and mobile. ClarifiesstatusJidListrules and standardizes media examples. Closes #2633.status@broadcastwithstatusJidList; broadcast lists use their own JID (e.g.1234@broadcast) and don’t requirestatusJidList.backgroundColorandfont.contextInfo.featureEligibilities.canBeReshared; requires “Allow Resharing” enabled in sender’s privacy settings.ptt: trueandbackgroundColorfor mobile visibility; example uses{ url }with a Buffer alternative noted.ffmpegto wrap audio in a video.Written for commit 651e087. Summary will update on new commits.
Summary by CodeRabbit