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

    View an announcement

    Retrieves information on a specific announcement.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/announcements/{unique_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    unique_id

    string

    Specifies the unique ID of an announcement.


    Response

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

    {
        "unique_id": "marketing_announcement_20200211",
        "announcement_group": "insurance",
        "message": {
            "type": "MESG",
            "custom_type": "campaign",
            "user_id": "insurance_bot",
            "content": "Smart ways to save your insurance premiums!",
            "data": ""
        },
        "enable_push": true,
        "target_at": "sender_all_channels",
        "target_user_count": -1,
        "target_channel_count": -1,
        "status": "scheduled",
        "scheduled_at": 1542756099266,
        "cease_at": "2100",
        "resume_at": "0900",
        "completed_at": 0,
        "sent_user_count": 0,
        "open_count": 0,
        "open_rate": 0
    }
    

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