docs(telegram): document Bot API 10.0 guest mode media delivery - #56297
docs(telegram): document Bot API 10.0 guest mode media delivery#56297elphamale wants to merge 2 commits into
Conversation
teknium1
left a comment
There was a problem hiding this comment.
Thanks for documenting the operator-facing behavior of the proposed guest-media flow.
Problems
- Current
mainonly has the mention-bypass implementation (plugins/platforms/telegram/adapter.py:6713-6720,:7443-7465) and its corresponding guide section (website/docs/user-guide/messaging/telegram.md:1044-1070). It does not yet implementguest_message,answerGuestQuery, or the media delivery-token flow documented here.
Suggested changes
- Keep this docs change paired with the canonical implementation from the still-open #56476/#56477 stack, and validate the final wording against the landed implementation before it is merged.
Automated hermes-sweeper review.
| @@ -1069,6 +1069,32 @@ With `guest_mode: true`, a message from a non-allowlisted group is processed **o | |||
|
|
|||
| DMs and allowlisted groups behave exactly as before. | |||
|
|
|||
| ### Native guest replies (Bot API 10.0) | |||
Guest mode's guest_message/answerGuestQuery flow (two-phase stub reply, deliver-token media button) ships in NousResearch#51886 and NousResearch#52639 but was never documented — the existing guest_mode section only covers the pre-Bot-API-10.0 @mention bypass. Adds the missing behavior, config (TELEGRAM_HOME_CHANNEL), and limitations (10-minute token TTL, no session stickiness) to the user-guide so operators know what to expect and how to enable file delivery. Requires NousResearch#51886 and NousResearch#52639 to be merged first — this documents behavior that doesn't exist on main yet.
…56476/NousResearch#56477 behavior Two statements had drifted from the implementation as it evolved under review: - Caller authorization wasn't documented at all. Guest mode gates the chat by mention, but the caller must also pass the bot's normal user authorization (allowlist/pairing, '*' opt-out, empty list denies everyone) -- added a "Who can use it" paragraph, including the operator-facing symptom of an unauthorized tester (silent bot + gateway log warning, easily mistaken for an outage). - "No session stickiness" is no longer true: guest sessions are keyed per chat + caller (the session-isolation fix), so repeat mentions from the same person deliberately continue their conversation. Reworded the limitation bullet and the pre-existing guest_mode paragraph to say what actually holds: mention required every turn, memory per caller.
|
Pushed Caller authorization was undocumented. #56476 gained a fail-closed caller gate during review (credit @mazzz3r): the chat is gated by mention, but the person mentioning must also pass the bot's normal user authorization — allowlist/pairing union, "No session stickiness" was no longer accurate. The session-isolation fix keys guest sessions per chat + caller (default |
86c221d to
d0c6df8
Compare
Summary
guest_message/answerGuestQueryreply flow (Bot API 10.0) added by feat(telegram): guest mode two-phase reply (Bot API 10.0, text-only) #56476 and feat(telegram): guest mode deliver_<token> media flow #56477: the two-phase stub → edit behavior, and the deliver-token media button flow for files that can't be attached directly to a guest reply.TELEGRAM_HOME_CHANNELconfig docs (staging chat required for cached-file delivery) and the documented limitations (10-minute delivery-token TTL, no session stickiness across guest turns).Why
The existing
guest_modesection only covers the pre-Bot-API-10.0 @mention bypass. The native two-phase reply and media delivery behavior shipped in #56476/#56477 has no user-facing documentation, so operators have no way to know whatTELEGRAM_HOME_CHANNELdoes or why a "tap to receive" button shows up instead of an inline file.Requires
This PR documents behavior that doesn't exist on
mainyet — please merge those first, or review this as a preview of the docs that will land alongside them.How to test
cd website && npm run build(oryarn build) to confirm the docs page builds without broken links/MDX errors.Platforms tested
Docs-only change, no runtime platform testing applicable.