Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    View an emoji category

    Retrieves a specific emoji category including its emojis.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/emoji_categories/{emoji_category_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    emoji_category_id

    int

    Specifies the unique ID of the emoji category to retrieve.


    Response

    If successful, this action returns an emoji category resource in the response body.

    {
        "id": 1,
        "name": "face",
        "url": "https://emojicategory.com/face_category",
        "emojis": [
            {
                "id": 1,
                "key": "smile",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f600.png"
            },
            {
                "id": 2,
                "key": "angry",
                "url": "https://emojikeyboard.io/img/img-apple-64/1f620.png"
            },
            ... # More emojis
        ]
    }
    

    In the case of an error, an error object is returned. A detailed list of error codes is available here.