List announcements

GET {{baseUrl}}/v3/announcements

List announcements

Retrieves a list of announcements.

https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-list-announcements

Request Params

KeyDatatypeRequiredDescription
tokenstring
limitstring
orderstring
statusstring
announcement_groupstring

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Acceptstring

RESPONSES

status: OK

{"announcements":[{"unique_id":"\u003cstring\u003e","announcement_group":"\u003cstring\u003e","message":{"type":"\u003cstring\u003e","custom_type":"\u003cstring\u003e","user_id":"\u003cstring\u003e","content":"\u003cstring\u003e","data":"\u003cstring\u003e"},"enable_push":"\u003cboolean\u003e","target_at":"\u003cstring\u003e","target_user_count":"\u003cnumber\u003e","target_channel_count":"\u003cnumber\u003e","status":"\u003cstring\u003e","scheduled_at":"\u003cnumber\u003e","cease_at":"\u003cstring\u003e","resume_at":"\u003cstring\u003e","completed_at":"\u003cnumber\u003e","sent_user_count":"\u003cnumber\u003e","open_count":"\u003cnumber\u003e","open_rate":"\u003cnumber\u003e","create_channel":"\u003cboolean\u003e","create_channel_options":{"distinct":"\u003cboolean\u003e","data":"\u003cstring\u003e","name":"\u003cstring\u003e","cover_url":"\u003cstring\u003e","custom_type":"\u003cstring\u003e"},"end_at":"\u003cnumber\u003e","mark_as_read":"\u003cboolean\u003e","sent_channel_count":"\u003cnumber\u003e","target_channel_type":"\u003cstring\u003e","target_custom_type":"\u003cstring\u003e"},{"unique_id":"\u003cstring\u003e","announcement_group":"\u003cstring\u003e","message":{"type":"\u003cstring\u003e","custom_type":"\u003cstring\u003e","user_id":"\u003cstring\u003e","content":"\u003cstring\u003e","data":"\u003cstring\u003e"},"enable_push":"\u003cboolean\u003e","target_at":"\u003cstring\u003e","target_user_count":"\u003cnumber\u003e","target_channel_count":"\u003cnumber\u003e","status":"\u003cstring\u003e","scheduled_at":"\u003cnumber\u003e","cease_at":"\u003cstring\u003e","resume_at":"\u003cstring\u003e","completed_at":"\u003cnumber\u003e","sent_user_count":"\u003cnumber\u003e","open_count":"\u003cnumber\u003e","open_rate":"\u003cnumber\u003e","create_channel":"\u003cboolean\u003e","create_channel_options":{"distinct":"\u003cboolean\u003e","data":"\u003cstring\u003e","name":"\u003cstring\u003e","cover_url":"\u003cstring\u003e","custom_type":"\u003cstring\u003e"},"end_at":"\u003cnumber\u003e","mark_as_read":"\u003cboolean\u003e","sent_channel_count":"\u003cnumber\u003e","target_channel_type":"\u003cstring\u003e","target_custom_type":"\u003cstring\u003e"}],"next":"\u003cstring\u003e"}