@@ -1287,6 +1287,71 @@ paths:
12871287 - Application
12881288 x-content-type: application/json
12891289 x-accepts: application/json
1290+ /v3/applications/settings/auto_event_message:
1291+ get:
1292+ description: |-
1293+ ## List auto event messages
1294+
1295+ Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use. Auto event messages are Admin messages that are automatically generated when a specific event occurs.
1296+
1297+ https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/list-auto-event-messages
1298+ ----------------------------
1299+ operationId: listAutoEventMessages
1300+ parameters:
1301+ - example: "{{API_TOKEN}}"
1302+ explode: false
1303+ in: header
1304+ name: Api-Token
1305+ required: true
1306+ schema:
1307+ type: string
1308+ style: simple
1309+ responses:
1310+ "200":
1311+ content:
1312+ application/json:
1313+ schema:
1314+ $ref: '#/components/schemas/SendBird.AutoEventMessageSettings'
1315+ description: Successful response
1316+ summary: List auto event messages
1317+ tags:
1318+ - Application
1319+ x-accepts: application/json
1320+ put:
1321+ description: |-
1322+ ## Configure auto event message settings
1323+
1324+ Determines whether to automatically send event messages to group channels when events take place in an application. You can choose which auto event message to receive on the Sendbird Dashboard
1325+
1326+ https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/configure-auto-event-message-settings
1327+ ----------------------------
1328+ operationId: configureAutoEventMessages
1329+ parameters:
1330+ - example: "{{API_TOKEN}}"
1331+ explode: false
1332+ in: header
1333+ name: Api-Token
1334+ required: true
1335+ schema:
1336+ type: string
1337+ style: simple
1338+ requestBody:
1339+ content:
1340+ application/json:
1341+ schema:
1342+ $ref: '#/components/schemas/configureAutoEventData'
1343+ responses:
1344+ "200":
1345+ content:
1346+ application/json:
1347+ schema:
1348+ $ref: '#/components/schemas/SendBird.AutoEventMessageSettings'
1349+ description: Successful response
1350+ summary: Configure auto event message settings
1351+ tags:
1352+ - Application
1353+ x-content-type: application/json
1354+ x-accepts: application/json
12901355 /v3/users:
12911356 get:
12921357 description: |-
@@ -5762,7 +5827,7 @@ paths:
57625827 description: Successful response
57635828 summary: Schedule an announcement
57645829 tags:
5765- - Message
5830+ - Announcement
57665831 x-content-type: application/json
57675832 x-accepts: application/json
57685833 /v3/announcements/{unique_id}:
@@ -5841,7 +5906,7 @@ paths:
58415906 description: Successful response
58425907 summary: Update an announcement
58435908 tags:
5844- - Message
5909+ - Announcement
58455910 x-content-type: application/json
58465911 x-accepts: application/json
58475912 /v3/announcement_open_rate/{unique_id}:
@@ -5876,7 +5941,7 @@ paths:
58765941 description: Successful response
58775942 summary: Get detailed open rate of an announcement
58785943 tags:
5879- - Announcement
5944+ - Statistics
58805945 x-accepts: application/json
58815946 /v3/announcement_open_status/{unique_id}:
58825947 get:
@@ -5952,7 +6017,7 @@ paths:
59526017 description: Successful response
59536018 summary: Get detailed open status of an announcement
59546019 tags:
5955- - Announcement
6020+ - Statistics
59566021 x-accepts: application/json
59576022 /v3/announcement_stats/daily:
59586023 get:
@@ -6027,7 +6092,7 @@ paths:
60276092 description: Successful response
60286093 summary: Get statistics - daily
60296094 tags:
6030- - Message
6095+ - Announcement
60316096 x-accepts: application/json
60326097 /v3/announcement_stats/weekly:
60336098 get:
@@ -6053,7 +6118,7 @@ paths:
60536118 description: Successful response
60546119 summary: Get statistics - weekly
60556120 tags:
6056- - Message
6121+ - Announcement
60576122 x-accepts: application/json
60586123 /v3/announcement_stats/monthly:
60596124 get:
@@ -6079,7 +6144,7 @@ paths:
60796144 description: Successful response
60806145 summary: Get statistics - monthly
60816146 tags:
6082- - Message
6147+ - Announcement
60836148 x-accepts: application/json
60846149 /v3/announcement_group:
60856150 get:
@@ -6123,7 +6188,7 @@ paths:
61236188 description: Successful response
61246189 summary: List announcement groups
61256190 tags:
6126- - Message
6191+ - Announcement
61276192 x-accepts: application/json
61286193 /v3/announcement_open_rate_by_group/{announcement_group}:
61296194 get:
@@ -11324,6 +11389,17 @@ components:
1132411389 $ref: '#/components/schemas/viewPushNotificationContentTemplateResponse_push_message_templates_inner'
1132511390 type: array
1132611391 type: object
11392+ SendBird.AutoEventMessageSettings:
11393+ example:
11394+ auto_event_message:
11395+ channel_change: "{}"
11396+ user_join: "{}"
11397+ user_leave: "{}"
11398+ channel_create: "{}"
11399+ properties:
11400+ auto_event_message:
11401+ $ref: '#/components/schemas/configureAutoEventData_auto_event_message'
11402+ type: object
1132711403 createUserResponse:
1132811404 $ref: '#/components/schemas/SendBird.User'
1132911405 listUsersResponse:
@@ -11954,9 +12030,6 @@ components:
1195412030 type: object
1195512031 addRegistrationOrDeviceTokenResponse:
1195612032 example:
11957- tokens:
11958- - tokens
11959- - tokens
1196012033 type: type
1196112034 user:
1196212035 end_at: 1.4658129805029452
@@ -11988,18 +12061,10 @@ components:
1198812061 is_online: true
1198912062 last_seen_at: 0
1199012063 is_hide_me_from_friends: true
11991- token:
11992- - token
11993- - token
12064+ token: token
1199412065 properties:
11995- tokens:
11996- items:
11997- type: string
11998- type: array
1199912066 token:
12000- items:
12001- type: string
12002- type: array
12067+ type: string
1200312068 type:
1200412069 type: string
1200512070 user:
@@ -17372,6 +17437,28 @@ components:
1737217437 - template_name
1737317438 title: updatePushNotificationContentTemplateData
1737417439 type: object
17440+ configureAutoEventData_auto_event_message:
17441+ example:
17442+ channel_change: "{}"
17443+ user_join: "{}"
17444+ user_leave: "{}"
17445+ channel_create: "{}"
17446+ properties:
17447+ user_leave:
17448+ type: object
17449+ user_join:
17450+ type: object
17451+ channel_create:
17452+ type: object
17453+ channel_change:
17454+ type: object
17455+ type: object
17456+ configureAutoEventData:
17457+ properties:
17458+ auto_event_message:
17459+ $ref: '#/components/schemas/configureAutoEventData_auto_event_message'
17460+ title: configureAutoEventData
17461+ type: object
1737517462 createUserData:
1737617463 properties:
1737717464 user_id:
@@ -18474,21 +18561,30 @@ components:
1847418561 - user_id
1847518562 title: gcMuteUserData
1847618563 type: object
18564+ scheduleAnnouncementData_message:
18565+ description: "The [message](/docs/chat/v3/platform-api/guides/messages#-3-resource-representation)\
18566+ \ of a new announcement."
18567+ properties:
18568+ type:
18569+ type: string
18570+ user_id:
18571+ type: string
18572+ content:
18573+ type: string
18574+ type: object
1847718575 scheduleAnnouncementData:
1847818576 properties:
1847918577 message:
18480- description: "The [message](/docs/chat/v3/platform-api/guides/messages#-3-resource-representation)\
18481- \ of a new announcement."
18482- type: string
18483- message.type:
18578+ $ref: '#/components/schemas/scheduleAnnouncementData_message'
18579+ message_type:
1848418580 description: "Specifies the type of the message, which can be either MESG\
1848518581 \ for a text message and ADMM for an admin message."
1848618582 type: string
18487- message. user_id:
18583+ user_id:
1848818584 description: "Specifies the unique ID of the sender when the message.type\
1848918585 \ is MESG. When the message.type value is ADMM, this property is not effective."
1849018586 type: string
18491- message. content:
18587+ content:
1849218588 description: Specifies the content of the message.
1849318589 type: string
1849418590 target_at:
@@ -18780,6 +18876,26 @@ components:
1878018876 \ ranges from 0.0 to 1.0, which indicates silent and full volume, respectively.\
1878118877 \ (Default 1.0)"
1878218878 type: number
18879+ url:
18880+ type: string
18881+ file:
18882+ type: string
18883+ file_name:
18884+ type: string
18885+ file_size:
18886+ type: number
18887+ file_type:
18888+ type: string
18889+ thumbnails:
18890+ items:
18891+ type: string
18892+ type: array
18893+ thumbnail1:
18894+ type: string
18895+ thumbnail2:
18896+ type: string
18897+ thumbnail3:
18898+ type: string
1878318899 required:
1878418900 - message
1878518901 - message_type
0 commit comments