/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    List announcement groups

    Copy link

    Retrieves a list of announcement groups.

    HTTP request

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

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Optional
    Parameter nameTypeDescription

    token

    string

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

    limit

    integer

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

    ?limit=20&token=Z3UYLAYLAAoaTxgADAwNQD8~

    Response

    Copy link

    If successful, this action returns a list of announcement groups in the response body.

    {
    "announcement_group": ["insurance", "finance", ... ],
    "next": "Z3jk34n2uj=e23E2z"
}

    List of response properties

    Copy link
    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.

    On this page
    HTTP requestParametersResponse