/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Start typing indicators

    Copy link

    You can start showing a typing indicator using this API. Seeing whether other users are typing can help a more interactive conversation environment by showing real-time engagement of other users.

    If you're looking for an easy way to show typing indicators on your app, check out Sendbird UIKit for a ready-to-use UI feature that can be customized to fit your needs.

    Limitations

    Copy link
    • This feature is only applicable to group channels.

    • When there are 100 or more members in a group channel, typing indicator events of up to two users are delivered to other users. Once typing indicator events of three or more users occur, the events aren't delivered to users.


    HTTP request

    Copy link
    POST https://api-{application_id}.sendbird.com/v3/group_channels/{channel_url}/typing
    

    Request body

    Copy link

    The following table lists the properties of an HTTP request that this action supports.

    Required
    Property nameTypeDescription

    user_ids

    array of strings

    Specifies an array of IDs of users who are to use the typing indicator. You can list up to ten user IDs.

    {
        "user_ids": ["kay", "lucha"]
    }
    

    Responses

    Copy link

    If successful, this action returns an empty response body.

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "\"User\" not found.",
        "code": 400201,
        "error": true
    }