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

    View number of scheduled messages

    Copy link

    This action retrieves the total number of scheduled messages that a user has.


    HTTP request

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/scheduled_messages/count
    

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    sender_id

    string

    Specifies the user ID of the sender.

    OptionalTypeDescription

    channel_type

    string

    Specifies the type of the channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of the target channel.

    status[]

    array of strings

    Specifies the scheduled message status to retrieve. If not specified, all scheduled messages are returned, regardless of their status.

    message_type

    string

    Specifies a message type to retrieve. Acceptable values are MESG, FILE, and ADMM. If not specified, the scope of retrieval is set to all messages.


    Response

    Copy link

    If successful, this action returns a list of scheduled messages resource in the response body.

    {
        "count": 50
    } 
    

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