Document voice messages. #6082

tpcstld · 2023-04-14T21:49:49Z

Summary

Voice messages has hit a form of general availability so it's time to bust out the API docs.

One thing to note is that even though voice messages are implemented as attachments, they do not require the Attach Files permission. The gating is purely on the Send Voice Message permission.

Bots are currently not able to send voice messages, mainly as a short-term implementation detail. This will change... eventually.

I wanted to document some implementation details about voice messages, but I'm not sure where to in the docs. So I just put there where I thought makes sense lol.

Also not sure if there's additional places that I should change 🤔

Puncher1 · 2023-04-14T21:55:35Z

docs/resources/Channel.md

+| height?        | ?integer  | height of file (if image)                                                               |
+| width?         | ?integer  | width of file (if image)                                                                |
+| ephemeral? \*  | boolean   | whether this attachment is ephemeral                                                    |
+| duration_secs? | integer   | the duration of the audio file (currently for voice messages)                           |


Lulalaby · 2023-04-14T21:58:33Z

Also not sure if there's additional places that I should change

Seems to be not the case. That should be all (referencing my own implementation of voice messages).

Misha-133 · 2023-04-14T22:01:12Z

Shouldn't this also document the 50173 error?

{
    "message": "Cannot send voice messages in this channel",
    "code": 50173
}

wasdennnoch · 2023-04-14T22:00:28Z

docs/resources/Channel.md

+
+- They cannot be edited.
+- Only a single audio attachment is allowed. No content, stickers, etc...
+- The attachment has additional fields: `duration_secs` and `waveform`.


Suggested change

- The attachment has additional fields: `duration_secs` and `waveform`.

- The [attachment](#DOCS_RESOURCES_CHANNEL/attachment-object) object has additional fields: `duration_secs` and `waveform`.

Lulalaby · 2023-04-14T22:02:58Z

Shouldn't this also document the 50173 error?

Bots are currently not able to send voice messages, mainly as a short-term implementation detail. This will change... eventually.

probably not as bots cannot encounter that atm

Jupith · 2023-04-14T22:03:41Z

They can encounter it

Misha-133 · 2023-04-14T22:03:49Z

They can :-)
I tried sending a voice message with a bot & got this error

Lulalaby · 2023-04-14T22:04:54Z

Then the error code is incorrect.
It should be something like "Bots cannot send voice messages"

tpcstld · 2023-04-14T22:07:51Z

In order to ease the bikeshedding of error codes here:

I don't think we really document errors anymore due to the amount of possible different errors.
I'm not gonna change the error message just for bots. Sorry. :P

Jupith · 2023-04-14T22:11:09Z

it works with bots if you send btw x-super-properties: eyJvcyI6IldpbmRvd3MiLCJjbGllbnRfYnVpbGRfbnVtYmVyIjo5OTk5OTk5fQ==

discord/discord-api-docs#6082

MinnDevelopment · 2023-04-15T00:30:25Z

docs/resources/Channel.md

+| width?         | ?integer  | width of file (if image)                                                                |
+| ephemeral? \*  | boolean   | whether this attachment is ephemeral                                                    |
+| duration_secs? | float     | the duration of the audio file (currently for voice messages)                           |
+| waveform?      | string    | base64 encoded bytearray representing a sampled waveform (currently for voice messages) |


Would it be worthwhile to document the exact format of this data? Apparently it's 8bit 10Hz

Rapptz · 2023-04-15T00:57:04Z

In order to ease the bikeshedding of error codes here:

I don't think we really document errors anymore due to the amount of possible different errors.

I'm not gonna change the error message just for bots. Sorry. :P

Is this a reversal of the previous reversal? This was brought up before with its removal but it was an unpopular decision (see #4427 and its subsequent reversal).

Ref: discord/discord-api-docs#6082

tpcstld · 2023-04-18T00:01:37Z

In order to ease the bikeshedding of error codes here:

I don't think we really document errors anymore due to the amount of possible different errors.

I'm not gonna change the error message just for bots. Sorry. :P

Is this a reversal of the previous reversal? This was brought up before with its removal but it was an unpopular decision (see #4427 and its subsequent reversal).

No I'm just misaligned. I spoke with them and I'll sync the error codes for voice messages one time in this PR :P

Lulalaby · 2023-04-18T00:04:19Z

Thank you!

see discord/discord-api-docs#6082 --------- Co-authored-by: Lukellmann <lukellmann@gmail.com>

* feat: voice message support Ref: discord/discord-api-docs#6082 * keep the waveform as-is While currently the docs specify it is a base64 byte array, it might be more worthwhile to give the API consumer a raw string and let them deal with it appropriately. Let alone this is probably a more future-proof variant, as (although very unlikely) the format could change in the future.

discord/discord-api-docs#6082

No breaking changes. Newly added: - `Attachment` fields: `duration_secs`, `waveform` - `MessageFlags` bitflag: `IS_VOICE_MESSAGE` - `model::Error` variant: `CannotEditVoiceMessage` - `Permissions` bitflag: `SEND_VOICE_MESSAGES` discord/discord-api-docs#6082

See discord/discord-api-docs#6082.

* feat: voice message support Ref: discord/discord-api-docs#6082 * keep the waveform as-is While currently the docs specify it is a base64 byte array, it might be more worthwhile to give the API consumer a raw string and let them deal with it appropriately. Let alone this is probably a more future-proof variant, as (although very unlikely) the format could change in the future.

No breaking changes. Newly added: - `Attachment` fields: `duration_secs`, `waveform` - `MessageFlags` bitflag: `IS_VOICE_MESSAGE` - `model::Error` variant: `CannotEditVoiceMessage` - `Permissions` bitflag: `SEND_VOICE_MESSAGES` discord/discord-api-docs#6082

Document voice messages.

d977002

Mateo-tem mentioned this pull request Apr 14, 2023

feat: add support for voice messages discordjs/discord-api-types#749

Merged

Puncher1 reviewed Apr 14, 2023

View reviewed changes

mlnrDev mentioned this pull request Apr 14, 2023

Add voice messages disgoorg/disgo#265

Merged

wasdennnoch reviewed Apr 14, 2023

View reviewed changes

Updates.

c287228

almeidx mentioned this pull request Apr 14, 2023

feat(Attachment): voice messages discordjs/discord.js#9392

Merged

Misha-133 mentioned this pull request Apr 14, 2023

[Feature] Voice messages support discord-net/Discord.Net#2665

Merged

Lulalaby mentioned this pull request Apr 14, 2023

feat: voice message support Pycord-Development/pycord#2016

Merged

Puncher1 mentioned this pull request Apr 14, 2023

Support for voice messages Rapptz/discord.py#9358

Merged

6 tasks

DonovanDMC added a commit to OceanicJS/Oceanic that referenced this pull request Apr 14, 2023

voice messages

1155fa3

discord/discord-api-docs#6082

RedDaedalus mentioned this pull request Apr 14, 2023

Add voice message read support discord-jda/JDA#2445

Merged

6 tasks

MinnDevelopment reviewed Apr 15, 2023

View reviewed changes

suneettipirneni mentioned this pull request Apr 15, 2023

feat(model, cache): add support for voice messages twilight-rs/twilight#2196

Merged

MinnDevelopment mentioned this pull request Apr 15, 2023

Update permissions discord-jda/JDA#2434

Merged

6 tasks

RealYusufIsmail mentioned this pull request Apr 15, 2023

Add voice message support to text channel Javacord/Javacord#1237

Closed

DRSchlaubi mentioned this pull request Apr 15, 2023

Add support for voice messages kordlib/kord#814

Merged

TTtie added a commit to projectdysnomia/dysnomia that referenced this pull request Apr 15, 2023

feat: voice message support

2ad80d0

Ref: discord/discord-api-docs#6082

TTtie mentioned this pull request Apr 15, 2023

feat: voice message support projectdysnomia/dysnomia#67

Merged

seailz mentioned this pull request Apr 18, 2023

[Feature Request] Add Voice Messages discord-jar/discord.jar#161

Closed

3 tasks

More updates.

2602706

tpcstld merged commit 70bc0f0 into main Apr 19, 2023
4 checks passed

tpcstld deleted the tpcstld/voice-messages branch April 19, 2023 15:35

lukellmann added a commit to kordlib/kord that referenced this pull request Apr 20, 2023

Add support for voice messages (#814)

e9ec786

see discord/discord-api-docs#6082 --------- Co-authored-by: Lukellmann <lukellmann@gmail.com>

kangalio added a commit to kangalio/serenity that referenced this pull request Apr 20, 2023

Implement voice messages

16fd3f9

discord/discord-api-docs#6082

kangalio mentioned this pull request Apr 20, 2023

Implement voice messages serenity-rs/serenity#2392

Merged

KubaZ2 added a commit to NetCordDev/NetCord that referenced this pull request Apr 21, 2023

Add voice messages (discord/discord-api-docs#6082)

c41204f

Nihlus added a commit to Remora/Remora.Discord that referenced this pull request May 1, 2023

Implement support for voice messages.

f455a0a

See discord/discord-api-docs#6082.

Azn9 mentioned this pull request Jul 17, 2023

Added missing methods getDurationSeconds, getWaveform and getFlags for Attachment Discord4J/Discord4J#1156

Merged

spifory mentioned this pull request Aug 15, 2023

feat: add voice messages nextcord/nextcord#1111

Open

3 tasks

davfsa mentioned this pull request Dec 7, 2023

Support sending voice messages hikari-py/hikari#1780

Open

1 task

shaydewael pushed a commit to Jupith/discord-api-docs that referenced this pull request May 14, 2024

Document voice messages. (discord#6082)

c087d54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document voice messages. #6082

Document voice messages. #6082

tpcstld commented Apr 14, 2023 •

edited

Puncher1 Apr 14, 2023 •

edited

Lulalaby commented Apr 14, 2023

Misha-133 commented Apr 14, 2023

wasdennnoch Apr 14, 2023

Lulalaby commented Apr 14, 2023

Jupith commented Apr 14, 2023

Misha-133 commented Apr 14, 2023

Lulalaby commented Apr 14, 2023

tpcstld commented Apr 14, 2023

Jupith commented Apr 14, 2023

MinnDevelopment Apr 15, 2023

Rapptz commented Apr 15, 2023

tpcstld commented Apr 18, 2023

Lulalaby commented Apr 18, 2023

	\| duration_secs? \| integer \| the duration of the audio file (currently for voice messages) \|
	\| duration_secs? \| float \| the duration of the audio file (currently for voice messages) \|

	- The attachment has additional fields: `duration_secs` and `waveform`.
	- The [attachment](#DOCS_RESOURCES_CHANNEL/attachment-object) object has additional fields: `duration_secs` and `waveform`.

Document voice messages. #6082

Document voice messages. #6082

Conversation

tpcstld commented Apr 14, 2023 • edited

Summary

Puncher1 Apr 14, 2023 • edited

Choose a reason for hiding this comment

Lulalaby commented Apr 14, 2023

Misha-133 commented Apr 14, 2023

wasdennnoch Apr 14, 2023

Choose a reason for hiding this comment

Lulalaby commented Apr 14, 2023

Jupith commented Apr 14, 2023

Misha-133 commented Apr 14, 2023

Lulalaby commented Apr 14, 2023

tpcstld commented Apr 14, 2023

Jupith commented Apr 14, 2023

MinnDevelopment Apr 15, 2023

Choose a reason for hiding this comment

Rapptz commented Apr 15, 2023

tpcstld commented Apr 18, 2023

Lulalaby commented Apr 18, 2023

tpcstld commented Apr 14, 2023 •

edited

Puncher1 Apr 14, 2023 •

edited