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

    View detailed open status of an announcement

    Retrieves detailed open status information on a specific announcement.


    HTTP request

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

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    unique_id

    string

    Specifies the unique ID of an announcement.

    OptionalTypeDescription

    token

    string

    Specifies a token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.

    limit

    int

    Specifies the number of results to retrieve per page. Acceptable values are 1 to 100, inclusive. (Default: 10)


    Request body

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

    Optional
    Property nameTypeDescription

    unique_ids

    array of strings

    Specifies an array of target users' unique IDs to get the open status data on.

    channel_urls

    array of strings

    Specifies an array of channel URLs to get the open status data on.

    has_opened

    boolean

    Determines whether to restrict the scope to only retrieve open status data of target users who have opened the announcement. If set to false, this property returns the open status of target users who haven't opened the announcement. If not specified, all target users' open status are returned.


    Response

    If successful, this action returns the open status information about a specific announcement in the response body.

    {
        "open_status": [
            {
                "user_id": "Jeff",
                "channel_url": "sendbird_group_channel_1c878fc2fd42dfa99898899936",
                "has_opened": true,
                "sent_at": 1642660888951,
                "open_at": 1642660999999
            },
            {
                "user_id": "Cindy",
                "channel_url": "sendbird_group_channel_4gf8ed809dfa00398347af5211",
                "has_opened": false,
                "sent_at": 1642660888801,
                "open_at": -1
            },
            ... # More open status
        ],
        "next": "a3JKe1kane93ZXk32nkl"
    }
    

    List of response properties

    Property nameTypeDescription

    next

    string

    The value that can be used in the token parameter to retrieve the next page in the result set.

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