Changes to interaction responses and flags #2615

msciotti · 2021-02-17T00:25:22Z

Slash Commands UI Changes

DISCLAIMER: These changes are still being worked on so this PR will merge when they are complete

Hey all! Another day, another update. This time, we want to talk about UI changes and how we're gonna support them.

We've gotten a lot of feedback that the in-chat view of commands could be improved:

We agree. After seeing some bots integrate and using Slash Commands a bunch ourselves, we've decided to take some extra steps into making slash commands feel better than just copying what bots did before.

Check out the designs here

There's a few changes within these designs:

Slash commands and bot responses are now combined into one message
All slash commands now have the "User used" source message and a bot response. You can no longer hide the source
The raw text of the source command can be seen on hover on desktop or by tapping to bring up a half sheet on mobile
You can't send a public source message with an ephemeral response, or vice versa. Both will be either ephemeral or public because they are now one message, controlled by the flags field
"ACK" responses are being changed to "deferred" responses. They function the same way, but now indicate in the UI to the user that the bot is thinking, instead of not getting any acknowledgement

Why?

Having two separate messages felt weird. The "source" message was fairly useless, and took up a lot of space in chat
We needed to clearly show sending, pending, and error states to users in a way that they understood what "step" was being processed
Having a bot response without a user message, or vice versa, was confusing and led to inconsistent behavior, expectations, and designs
It looks a lot better, doesn't it?

API Changes

To support these new designs, we're going to be deprecating two interaction response types:

Pong is the same
Acknowledge will be deprecated
ChannelMessage will be deprecated
ChannelMessageWithSource will be the same
AcknowledgeWithSource will be renamed to DeferredChannelMessageWithSource

Additionally, sending flags: 1 << 6 for an ephemeral message response will make both the source message and the bot response ephemeral or public.

Here's the proposed updated data model:

Interaction Response Type

Name Value Description

Pong 1 ACK a Ping

ChannelMessageWithSource 4 Respond immediate to an interaction

DeferredChannelMessageWithSource 5 ACK an interaction and send a response later

Example Public Immediate Response
```
{
  "type": 4,
  "data": {
    "content": "Hi this is a response":
  }
}
```
Example Ephemeral Deferred Response
```
{
  "type": 5,
  "data": {
    "flags": 1 << 6
  }
}
```

GamingGeek · 2021-02-17T00:37:36Z

For the ephemeral response demo in the figma, is the initial source message visible to everyone while the command is being sent/application is thinking or is it only sent when the application responds?

msciotti · 2021-02-17T00:42:14Z

@GamingGeek there's a few states:

When the interaction is still being sent to Discord's servers, the source message is only visible to the invoking user.

When the third-party server responds, if it decides to respond ephemerally, the message will stay visible to only the user and we'll add the blue background.

If it decides to respond publicly, the message will appear in chat for everyone.

We didn't add the blue ephemeral background for the initial "bot has not yet responded" state because it was too jarring.

GamingGeek · 2021-02-17T00:45:58Z

@GamingGeek there's a few states:

When the interaction is still being sent to Discord's servers, the source message is only visible to the invoking user.

When the third-party server responds, if it decides to respond ephemerally, the message will stay visible to only the user and we'll add the blue background.

If it decides to respond publicly, the message will appear in chat for everyone.

We didn't add the blue ephemeral background for the initial "bot has not yet responded" state because it was too jarring.

Ah, makes sense. Thanks for the clarification, the changes look great :D

monbrey · 2021-02-17T00:55:31Z

If you defer responding with a 5, how do you then issue the deferred response? Is that a 4, or a follow-up message?

msciotti · 2021-02-17T00:56:31Z

@monbrey thank you for the question. You do so by using PATCH /@original. Let me update the docs.

docs/interactions/Slash_Commands.md

docs/Change_Log.md

MeguminSama · 2021-02-17T01:08:03Z

Any chance of "bot name is thinking" being customisable? whether returned in the deferred response, or set globally on the bot.

docs/interactions/Slash_Commands.md

Snazzah · 2021-02-17T06:15:13Z

Is DeferredChannelMessageWithSource only visible to the user who invoked the interaction?
Can you add a flags prop when editing the original message? (In order to make a DeferredChannelMessageWithSource become ephemeral)

advaith1 · 2021-02-17T06:18:28Z

ephemeral can be set in the initial "deferred" response, see the example at the bottom of the post and #2615 (comment)

msciotti · 2021-02-17T19:14:26Z

Any chance of "bot name is thinking" being customisable? whether returned in the deferred response, or set globally on the bot.

@MeguminSama you could technically customize this yourself but not doing a deferred message and sending an immediate response that looks like a loading message. Customizing that system string is not something planned.

I'm open to other, less anthropomorphized wording though. "Waiting on bot_name", or something else

prryplatypus · 2021-02-17T19:30:55Z

"Awaiting response from XXXX"?

Co-authored-by: Advaith <advaithj1@gmail.com>

ckohen · 2021-02-17T19:44:06Z

Just to be clear, with these changes there is no way to respond without a channel message correct? E.g. Some of my commands currently use ACK with source and send a message with the bot separately that gets deleted next time the command is used. This is done mainly because these messages are embeds that have minor changes with each usage and clutter up the history. However, that history is still nice / important to see for some commands.
I can think of a workaround for now - suppressing embeds on the message so the source is still visible at least.

msciotti · 2021-02-17T19:47:38Z

@ckohen that is correct. There always has to be both a source message and a bot response message, but you can choose if they are public or ephemeral.

We designed this for what we believe is the 99% use case of command --> reply, but are aware that there are other cases where you might not need a separate reply (our remake of Airhorn bot is this way currently, actually). For now we're going to err more on the side of standardization and wait and see what everyone does once this thing is launched and has widespread adoption.

But, these are comments/thoughts that we are aware of 👍

ckohen · 2021-02-17T19:50:18Z

Thanks!
On another note, #2410 seems to be closed by this PR. It natively provides the message object when using deferred due to the necessity to PATCH @original and I think this may end up being way more common than channel message anyways in order to avoid the risk of missing the 3 second timeout. Further, there's no longer an id of the "source" message.
Edit: I realize this is probably not "closing" the PR because of the tracking for the GET endpoint.

advaith1 · 2021-02-17T19:52:21Z

I think this may end up being way more common than channel message anyways in order to avoid the risk of missing the 3 second timeout

well that doesn't really change anything; sending a normal channel message will still be used and support for getting that message (without the PATCH workaround) should still be implemented

* remove redundant map structures * code cleanup * [WIP] - Rewrite Interaction Commands * Fix incorrect name reference * abstract rootName instead of name * Move documents to declaration and rename Command * More docs * correct sub-commands in docs * Fix filtered no-arg sub-commands * Add interaction serialization tests * Add interaction type testing * mark test class with KordPreview * WIP: Add resolvables * WIP: Use flows for resolved objects This most likely will be changed to a set or back to a map * Resolvables first prototype * Rename OptionValue to DiscordOptionValue * Create a core OptionValue to hold resolvable entities * Hold resolvable entities in the interaction command * consider MemberOption a UserOption * Serialize message flags as longs * Add Ephemeral flag * Change interaction response types discord/discord-api-docs#2615 * Use deferred response type for acknowledgement * Revert Message flags to ints * Fix incorrect endpoint call * Add multi-command put support * add mapeValues for maps data structure * Correct the json representations for new interactions * Add DmInteractions and GuildInteractions * Use put instead of post for bulk command registration * remove resolved field from interaction object * make deaf and mute optional * Core representations for bulk command end points * Code cleanup * Fix serialization for roles * Expose allowedMentions to followup builder (#187) * Apply suggestions * Code cleanup * Fix predicate and apply few tweaks Co-authored-by: Michael Rittmeister <michael@rittmeister.in>

msciotti · 2021-03-05T21:11:56Z

Changes are in! You'll see them next week when we turn on the feature flag in the API. It's disabled for now to give old clients time to get new code.

AnotherCat · 2021-03-06T00:19:27Z

I'm guessing that this #2615 (comment) is not possible, but can i get confirmation of this?

… type (#1252) This updates the interaction types to reflect the changes as laid in the slash commands UI changes pull request for Discord's API documentation: discord/discord-api-docs#2615. This removes the `Acknowledge` and `ChannelMessage` interaction response types, as they have been deprecated and scheduled for removal on the 9th of April, and renames `AcknowledgeWithSource` to `DeferredChannelMessageWithSource` to suit a better purpose. Furthermore, a new `MessageInteraction` type and its corresponding `interaction` field in `Message` is added. Additionally, a fix is incorporated to the interaction responses builders to use the correct field name for embeds (`embed` -> `embeds`).

References: discord/discord-api-docs#2667 - Update application command limits. - Add length assertion for `ApplicationCommandOptionChoice.value`. - Add `ApplicationCommandOptionChoice.__len__`. - Add `ApplicationCommandOption.__len__`. - Add `ApplicationCommand.__len__`. discord/discord-api-docs#2615 - Add `InteractionType`. - Add `InteractionEvent.type`. - Add `Message.interaction`. - Add `file` parameter to `Client.webhook_message_edit`. - Add `file` parameter to `Client.interaction_response_message_edit`. - Add `file` parameter to `Client.interaction_followup_message_edit`. discord/discord-api-docs#2690 - Add `InviteTargetType.EMBEDDED_APPLICATION`. - Add `Invite.target_application`. - Add `target_application` parameter to `Invite.precreate`. - Add `Client.application_invite_create`. discord/discord-api-docs#2692 - Add `ChannelVoice.region` attribute. - Add `region` parameter to `ChannelVoice.precreate`. - Add `region` parameter to `cr_pg_channel_object`. (Inherited by `Client.channel_create`.) - Add `region` parameter to `Client.channel_edit`. - Handle voice client disconnect when moving between voice channels of different regions. Public API: Coroutine generators yielded or returned from slash commands are handled as coroutine generator slash commands themselves. Add `SlashResponse` class. Update `slash.md`. Add `'number'` annotation to slash commands. Add `emoji.md` to topics. Add `Application.precreate`. Internal: Fix a broken docstring in `Color` (Reported by NeKun#9509). Add `URL.subdomain`. Add `URL.raw_subdomain`. Slash commands dropped back type based annotations. Redo slash command syncing to handle extensions correctly. `Application.__new__` could not set `.flags`. Update links in intro. Fix formatting issues in commands extension. `Extension._unload_extension` did not use executor when rendering exception traceback. Missing `ApplicationCommand.__ne__` caused errors (inheritance issues probably). Update `Guild.precreate.__doc__`. Remove unused `Guild.has_animated_icon` attribute (was removed like 1 year ago, lol). Add `region` parameter to `Guild.precreate`. Handle voice client player and reader stop when the guild's voice region changes. Do voice client reconnect for close code `1006`. `User.has_higher_role_than_at` could return `False` when the other other is not in the guild meanwhile self is.

see discord/discord-api-docs#2615

Andre601 · 2021-03-19T08:01:47Z

Not sure if this was asked here before (or if there are particular reasons for this) but does it make much sense to mention the name of the bot in the command message now?
Since the command is now "attached" to the response of the bot does it seem pointless to have with <bot> on it. Just having <user> used /<command> would now be enough to have here.

I'm referring to this here for those who aren't sure what I mean.
I also want to point out, that these changes, despite what is said here aren't live yet? Like it's more than a week now and I still see the bots using the old format, so unless they need specific changes to their code does this seem to not be live yet...
I personally doubt that the bot in question uses outdated code as it is used to test the Slash-command integration into JDA which is a current WIP thing...

(Oh and sorry for anyone I annoy with this message)

advaith1 · 2021-03-19T08:06:31Z

yes it was changed to just user used /command
the changes aren't live yet due to app store issues

TorKallon · 2021-03-23T18:22:16Z

Any news on when this will be live?

RedDaedalus · 2021-03-23T18:25:14Z

The change got pushed back due to an app store issue, last I heard the issue is resolved and the api change will go live in a few days so people have time to update.

MichaelJHarvey · 2021-03-25T00:07:42Z

Looks like the change has gone live.

Abu-Maher · 2021-03-26T00:46:38Z

YouTube together future, how can I make it with slash commands ?

TwilightZebby · 2021-03-26T07:43:32Z

@Abu-Maher You don't. It's an experimental feature and you shouldn't be trying to give yourself access to it by any means... Also, the YT/Voice Activities thing has nothing to do with this PR and Slash Commands/Interactions.

somebody1234 · 2021-03-26T08:20:22Z

Will attachments be possible with Edit Original Response (when using deferred response to do processing)? Currently, attachments can't be uploaded when editing messages

Are you sure they aren't already? Maybe you should try this out

interesting; looks like its undocumented but you can upload attachments while editing webhook messages and interaction responses, not for normal messages tho

would anyone happen to know if it also works when creating webhook messages and interaction responses?

advaith1 · 2021-03-26T15:50:43Z

@somebody1234 it's already documented for creating webhook messages so that isn't new; it doesn't work for creating interaction responses though (gotta use deferred + edit original for that)

remyjette · 2021-04-02T17:56:12Z

Is there any way to edit/delete the original message if it's ephemeral?

I can PATCH and DELETE at the /@original endpoint just find if I don't set flags, but if I set "flags": 64 on the InteractionApplicationCommandCallbackData then trying to talk to /@original gives me a 404.

GamingGeek · 2021-04-02T20:49:22Z

Is there any way to edit/delete the original message if it's ephemeral?

I can PATCH and DELETE at the /@original endpoint just find if I don't set flags, but if I set "flags": 64 on the InteractionApplicationCommandCallbackData then trying to talk to /@original gives me a 404.

Ephemeral messages are not stored so the API does not know it exists once the message is sent, hence the 404

Changes to interaction responses and flags

53389a8

msciotti mentioned this pull request Feb 17, 2021

User feedback in case of failure to respond #2375

Closed

Shadorc mentioned this pull request Feb 17, 2021

Application Commands Discord4J/Discord4J#818

Closed

1 task

clarify responding to deferred

711566a

advaith1 reviewed Feb 17, 2021

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

A5rocks reviewed Feb 17, 2021

View reviewed changes

advaith1 mentioned this pull request Feb 17, 2021

feat(APIInteractionResponse, APIInteractionResponseType): update for UI changes discordjs/discord-api-types#90

Merged

advaith1 reviewed Feb 17, 2021

View reviewed changes

docs/interactions/Slash_Commands.md Outdated Show resolved Hide resolved

queer mentioned this pull request Feb 17, 2021

Support new /command features mewna/catnip#517

Closed

Snazzah mentioned this pull request Feb 17, 2021

Slash Command API Changes Snazzah/slash-create#27

Closed

DjDeveloperr mentioned this pull request Feb 17, 2021

BREAKING: DM Slash Commands, new Interactions API changes harmonyland/harmony#106

Merged

This was referenced Feb 17, 2021

Add InteractionApplicationCommandCallbackData flags field Discord4J/discord-json#50

Closed

Work in progress: Changes to interaction responses and flags Discord4J/Discord4J#850

Merged

Update docs/interactions/Slash_Commands.md

3b28852

Co-authored-by: Advaith <advaithj1@gmail.com>

GamingGeek mentioned this pull request Feb 18, 2021

Upcoming interaction response/flag changes FireDiscordBot/bot#53

Merged

This comment has been minimized.

Sign in to view

update changelog

c37bfc4

msciotti merged commit ac350ce into master Mar 5, 2021

msciotti deleted the interactions/response-changes branch March 5, 2021 21:12

MeguminSama mentioned this pull request Mar 6, 2021

Implement API Changes MeguminSama/discord-slash-commands#21

Closed

arqunis mentioned this pull request Mar 6, 2021

Apply changes to interaction response types and add a new interaction type serenity-rs/serenity#1252

Merged

Shadorc mentioned this pull request Mar 6, 2021

Adds missing interaction responses fields Discord4J/discord-json#51

Merged

JRoy mentioned this pull request Mar 6, 2021

Implement discord interaction changes EssentialsX/Essentials#4040

Merged

advaith1 mentioned this pull request Mar 7, 2021

feat(APIMessage): add interaction discordjs/discord-api-types#93

Merged

itohatweb mentioned this pull request Mar 8, 2021

Changes to interaction responses and flags discordeno/discordeno#639

Closed

Vendicated mentioned this pull request Mar 12, 2021

Implement latest api changes MeguminSama/discord-slash-commands#22

Merged

LiBa001 added a commit to LiBa001/discord-interactions.py that referenced this pull request Mar 13, 2021

implement recent API changes

3dd35d6

see discord/discord-api-docs#2615

somebody1234 mentioned this pull request Mar 26, 2021

Files can be uploaded when *editing* a slash command response/webhook message discordeno/discordeno#686

Closed

Andols0 mentioned this pull request Mar 27, 2021

Removed deprecated iteractionResponseTypes GitSparTV/discordia-slash#1

Closed

LiBa001 mentioned this pull request May 7, 2021

Implement API changes LiBa001/discord-interactions.py#10

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes to interaction responses and flags #2615

Changes to interaction responses and flags #2615

msciotti commented Feb 17, 2021 •

edited by typpo

Loading

GamingGeek commented Feb 17, 2021

msciotti commented Feb 17, 2021 •

edited

Loading

GamingGeek commented Feb 17, 2021

monbrey commented Feb 17, 2021

msciotti commented Feb 17, 2021

MeguminSama commented Feb 17, 2021

Snazzah commented Feb 17, 2021 •

edited

Loading

advaith1 commented Feb 17, 2021

msciotti commented Feb 17, 2021 •

edited

Loading

prryplatypus commented Feb 17, 2021

ckohen commented Feb 17, 2021

msciotti commented Feb 17, 2021

ckohen commented Feb 17, 2021 •

edited

Loading

advaith1 commented Feb 17, 2021 •

edited

Loading

This comment has been minimized.

msciotti commented Mar 5, 2021

AnotherCat commented Mar 6, 2021

Andre601 commented Mar 19, 2021

advaith1 commented Mar 19, 2021

TorKallon commented Mar 23, 2021

RedDaedalus commented Mar 23, 2021

MichaelJHarvey commented Mar 25, 2021

Abu-Maher commented Mar 26, 2021

TwilightZebby commented Mar 26, 2021

somebody1234 commented Mar 26, 2021 •

edited

Loading

advaith1 commented Mar 26, 2021

remyjette commented Apr 2, 2021

GamingGeek commented Apr 2, 2021

Name	Value	Description
Pong	1	ACK a `Ping`
ChannelMessageWithSource	4	Respond immediate to an interaction
DeferredChannelMessageWithSource	5	ACK an interaction and send a response later

Changes to interaction responses and flags #2615

Changes to interaction responses and flags #2615

Conversation

msciotti commented Feb 17, 2021 • edited by typpo Loading

Slash Commands UI Changes

Why?

API Changes

Interaction Response Type

Example Public Immediate Response

Example Ephemeral Deferred Response

GamingGeek commented Feb 17, 2021

msciotti commented Feb 17, 2021 • edited Loading

GamingGeek commented Feb 17, 2021

monbrey commented Feb 17, 2021

msciotti commented Feb 17, 2021

MeguminSama commented Feb 17, 2021

Snazzah commented Feb 17, 2021 • edited Loading

advaith1 commented Feb 17, 2021

msciotti commented Feb 17, 2021 • edited Loading

prryplatypus commented Feb 17, 2021

ckohen commented Feb 17, 2021

msciotti commented Feb 17, 2021

ckohen commented Feb 17, 2021 • edited Loading

advaith1 commented Feb 17, 2021 • edited Loading

This comment has been minimized.

msciotti commented Mar 5, 2021

AnotherCat commented Mar 6, 2021

Andre601 commented Mar 19, 2021

advaith1 commented Mar 19, 2021

TorKallon commented Mar 23, 2021

RedDaedalus commented Mar 23, 2021

MichaelJHarvey commented Mar 25, 2021

Abu-Maher commented Mar 26, 2021

TwilightZebby commented Mar 26, 2021

somebody1234 commented Mar 26, 2021 • edited Loading

advaith1 commented Mar 26, 2021

remyjette commented Apr 2, 2021

GamingGeek commented Apr 2, 2021

msciotti commented Feb 17, 2021 •

edited by typpo

Loading

msciotti commented Feb 17, 2021 •

edited

Loading

Snazzah commented Feb 17, 2021 •

edited

Loading

msciotti commented Feb 17, 2021 •

edited

Loading

ckohen commented Feb 17, 2021 •

edited

Loading

advaith1 commented Feb 17, 2021 •

edited

Loading

somebody1234 commented Mar 26, 2021 •

edited

Loading