List Custom Emoji
    • Dark
      Light
    • PDF

    List Custom Emoji

    • Dark
      Light
    • PDF

    Article summary

    This method is planned to be removed by 7.0.0. Use the /emoji-custom.list endpoint instead.

    Returns a list of custom emoji registered in the workspace.

    Method

    Requires Auth

    listEmojiCustom

    Yes

    Example call

    {
        "msg": "method",
        "method": "listEmojiCustom",
        "id": "42",
        "params": []
    }

    Example response

    {
        "msg": "result",
        "id": "42",
        "result": [
            {
                "_id": "64a4ac9c7d04b8fc25af9c9d",
                "name": "hola",
                "aliases": [
                    "smiley"
                ],
                "extension": "png",
                "_updatedAt": {
                    "$date": 1688513692757
                }
            }
        ]
    }

    The emoji object

    The emoji object is defined as:

    • _id: The emoji ID.

    • name: The emoji-friendly name.

    • aliases: A collection of aliases for the emoji. The alias is used to identify the emoji on the text and for fast reference from typing (:emoji-alias:).

    • extension: The emoji file extension.

    • _updatedAt: The date when the emoji was updated in the workspace.

    Show the emoji image

    To show the custom emoji images, you simply need to request this URL:

    ${ path }/emoji-custom/${ encoded(name) } }.${ extension }

    For example:

    {
        "_id": "emoji-id",
        "name": "Emoji Name",
        "aliases": [ "emoji-alias" ],
        "extension": "png",
        "_updatedAt": { "$date": 1480377601 }
    }

    The URL to access this emoji will be:

    http://yourhost.com/emoji-custom/Emoji%20Name.png


    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence