Stickers documentation #2155

puddi · 2020-10-15T22:32:22Z

adding a new field to the messages object for stickers, with new tables to explain the actual new type of stickers object (joint work w/ @jfurrow)

apacheli · 2020-10-15T22:38:48Z

Any documentation for CDN?

We were discussing about the CDN URLs earlier in the Discord API server and discovered that https://discord.com/stickers and https://cdn.discordapp.com/stickers were both valid.

RedDaedalus · 2020-10-15T22:47:05Z

Error code 50081 might be worth documenting as well. Not sure since bots can't use stickers.

advaith1 · 2020-10-15T22:47:11Z

looks like bots can also access /sticker-packs/directory/:layoutid:

client uses the layout id 758482250722574376
error 10033 Unknown Store Directory Layout
query params with_store_listings boolean and country_code

and when bots try to send stickers in a message by including sticker_ids, it returns error 50081 Cannot use this sticker; will bot be able to send stickers in the future?

msciotti

Couple nits then LGTM.

It's worth adding the JSON error code to this table: https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes

And also documenting the CDN URL for stickers here: https://discord.com/developers/docs/reference#image-formatting-cdn-endpoints

msciotti · 2020-10-15T23:12:53Z

docs/resources/Channel.md

@@ -202,6 +202,7 @@ Represents a message sent in a channel within Discord.
 | application?              | [message application](#DOCS_RESOURCES_CHANNEL/message-object-message-application-structure) object                                              | sent with Rich Presence-related chat embeds                                                                                   |
 | message_reference?        | [message reference](#DOCS_RESOURCES_CHANNEL/message-object-message-reference-structure) object                                                  | reference data sent with crossposted messages                                                                                 |
 | flags?                    | integer                                                                                                                                         | [message flags](#DOCS_RESOURCES_CHANNEL/message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
+| stickers?                 | array of [sticker](#DOCS_RESOURCES_CHANNEL/message-sticker-structure) objects                                                            | the stickers sent with the message                                                                                            |


This needs to be #DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure

Also might be worth saying in the description that bots can only receive stickers, and not send them

msciotti · 2020-10-15T23:16:43Z

looks like bots can also access /sticker-packs/directory/:layoutid:

client uses the layout id 758482250722574376

error 10033 Unknown Store Directory Layout

query params with_store_listings boolean and country_code

and when bots try to send stickers in a message by including sticker_ids, it returns error 50081 Cannot use this sticker; will bot be able to send stickers in the future?

Bots don't need to access the directory layout so we can leave it undocumented. The team can decide if they wanna lock down the route or not. But the error code is worth documenting.

There's no ETA on bots sending stickers right now. It's a bit complex because of the necessity of entitlements to send stickers, and since bots can't "buy" things, they can't have an entitlement to send a sticker.

Feature request heard :) But probably not a thing in any near future unless it gets reprioritized.

advaith1 · 2020-10-16T18:13:14Z

docs/resources/Channel.md

@@ -202,6 +202,7 @@ Represents a message sent in a channel within Discord.
 | application?              | [message application](#DOCS_RESOURCES_CHANNEL/message-object-message-application-structure) object                                              | sent with Rich Presence-related chat embeds                                                                                   |
 | message_reference?        | [message reference](#DOCS_RESOURCES_CHANNEL/message-object-message-reference-structure) object                                                  | reference data sent with crossposted messages                                                                                 |
 | flags?                    | integer                                                                                                                                         | [message flags](#DOCS_RESOURCES_CHANNEL/message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) |
+| stickers?                 | array of [sticker](#DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure) objects                                                     | the stickers sent with the message (bots currently can only recieve messages with stickers, not send)                         |


Suggested change

| stickers? | array of [sticker](#DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure) objects | the stickers sent with the message (bots currently can only recieve messages with stickers, not send) |

| stickers? | array of [sticker](#DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure) objects | the stickers sent with the message (bots currently can only receive messages with stickers, not send) |

https://youtu.be/YHqERNzRkCE

advaith1 · 2020-10-16T18:20:26Z

docs/resources/Channel.md

+| preview_asset\*  | ?string   | sticker preview asset hash                                                            |
+| format_type      | integer   | [type of sticker format](#DOCS_RESOURCES_CHANNEL/message-object-sticker-format-types) |
+
+\* Sticker asset hashes currently cannot be resolved to an image.


this doesn't seem true though? at least for png/apng stickers; https://cdn.discordapp.com/stickers/748293547572330607/067a41f0df36a1d0925078ded077824c.png?size=512 is the image from the id and asset

@puddi Let's instead just say that the URL for fetching them is private

@advaith1 It's possible, but we don't want to yet document it. There's lots of undocumented but technically available things within our API. In this case, where we host stuff could be subject to change (since we have two URLs that resolve there right now, lol) and we don't want everyone scraping stickers yet outside of our experiment

@msciotti comment updated!

[ci skip]

msciotti

Would be good to add a small bit in Changelog.md saying these fields have been added. Otherwise LGTM

discord/discord-api-docs#2155

[ci skip]

jfurrow and others added 2 commits October 15, 2020 14:24

WIP stickers documentation

06d124e

finish up stickers documentation

80c7538

puddi requested a review from msciotti October 15, 2020 22:32

queer mentioned this pull request Oct 15, 2020

Support stickers mewna/catnip#490

Closed

msciotti requested changes Oct 15, 2020

View reviewed changes

GeopJr mentioned this pull request Oct 16, 2020

Add support for stickers discordcr/discordcr#217

Draft

SpaceEEC mentioned this pull request Oct 16, 2020

feat(Sticker): added Sticker discordjs/discord.js#4909

Merged

5 tasks

felldo mentioned this pull request Oct 16, 2020

Add stickers field to message Javacord/Javacord#653

Closed

puddi added 4 commits October 16, 2020 11:03

add error code for invalid sticker message

362fde6

be clear that bots currently cannot send sticker messages

e307459

fix whitespace

0e426eb

note for asset hashes

496fba1

advaith1 reviewed Oct 16, 2020

View reviewed changes

i before e, except after c

4455bc1

puddi requested a review from msciotti October 16, 2020 18:16

advaith1 reviewed Oct 16, 2020

View reviewed changes

update CDN comment

20a8096

vladfrangu mentioned this pull request Oct 18, 2020

Current sync status with Discord API Docs PRs discordjs/discord-api-types#31

Closed

23 tasks

advaith1 mentioned this pull request Oct 18, 2020

feat(Message): Stickers discordjs/discord-api-types#32

Merged

zeylahellyer mentioned this pull request Nov 1, 2020

Support Stickers twilight-rs/twilight#589

Closed

l7ssha added a commit to nyxx-discord/nyxx that referenced this pull request Nov 2, 2020

Implemented stickers discord/discord-api-docs#2155

16f2b79

[ci skip]

angelobreuer mentioned this pull request Nov 10, 2020

Adds Sticker object and stickers message field #2234

Closed

msciotti approved these changes Nov 13, 2020

View reviewed changes

add field to changelog

bb201c0

puddi merged commit b9ffd52 into master Nov 13, 2020

puddi deleted the stickers-docs branch November 13, 2020 23:18

Shadorc mentioned this pull request Nov 14, 2020

Support stickers in message Discord4J/discord-json#35

Merged

drklee3 mentioned this pull request Nov 14, 2020

Add support for stickers serenity-rs/serenity#1078

Merged

Shadorc mentioned this pull request Nov 14, 2020

Adds support for stickers Discord4J/Discord4J#808

Merged

BartArys added a commit to kordlib/kord that referenced this pull request Nov 28, 2020

Add Stickers

78a9519

discord/discord-api-docs#2155

AkiaCode mentioned this pull request Dec 17, 2020

Sticker support harmonyland/harmony#62

Closed

l7ssha added a commit to nyxx-discord/nyxx that referenced this pull request Feb 11, 2021

Implemented stickers discord/discord-api-docs#2155

238aa4b

[ci skip]

l7ssha added a commit to nyxx-discord/nyxx that referenced this pull request Mar 29, 2021

Implemented stickers discord/discord-api-docs#2155

bf88cb3

[ci skip]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stickers documentation #2155

Stickers documentation #2155

puddi commented Oct 15, 2020

apacheli commented Oct 15, 2020

RedDaedalus commented Oct 15, 2020

advaith1 commented Oct 15, 2020

msciotti left a comment

msciotti Oct 15, 2020

msciotti Oct 15, 2020

msciotti commented Oct 15, 2020

advaith1 Oct 16, 2020

advaith1 Oct 16, 2020

msciotti Oct 16, 2020

puddi Oct 16, 2020

msciotti left a comment

	\| stickers? \| array of [sticker](#DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure) objects \| the stickers sent with the message (bots currently can only recieve messages with stickers, not send) \|
	\| stickers? \| array of [sticker](#DOCS_RESOURCE_CHANNEL/message-object-message-sticker-structure) objects \| the stickers sent with the message (bots currently can only receive messages with stickers, not send) \|

Stickers documentation #2155

Stickers documentation #2155

Conversation

puddi commented Oct 15, 2020

apacheli commented Oct 15, 2020

RedDaedalus commented Oct 15, 2020

advaith1 commented Oct 15, 2020

msciotti left a comment

Choose a reason for hiding this comment

msciotti Oct 15, 2020

Choose a reason for hiding this comment

msciotti Oct 15, 2020

Choose a reason for hiding this comment

msciotti commented Oct 15, 2020

advaith1 Oct 16, 2020

Choose a reason for hiding this comment

advaith1 Oct 16, 2020

Choose a reason for hiding this comment

msciotti Oct 16, 2020

Choose a reason for hiding this comment

puddi Oct 16, 2020

Choose a reason for hiding this comment

msciotti left a comment

Choose a reason for hiding this comment