@@ -17744,6 +17744,333 @@ components:
1774417744 - s3_region
1774517745 title: S3Request
1774617746 type: object
17747+ ScheduledMessageContentResponse:
17748+ description: The message a scheduled message will send
17749+ properties:
17750+ attachments:
17751+ description: Array of message attachments
17752+ items:
17753+ $ref: '#/components/schemas/Attachment'
17754+ title: Message attachments
17755+ type: array
17756+ x-stream-docs-page-id: message_format#attachment-format
17757+ x-stream-index: "005"
17758+ custom:
17759+ additionalProperties: {}
17760+ type: object
17761+ x-stream-index: "020"
17762+ html:
17763+ description: Contains HTML markup of the message
17764+ title: HTML content
17765+ type: string
17766+ x-stream-index: "003"
17767+ mentioned_channel:
17768+ description: Whether the message mentions the whole channel
17769+ title: Mentioned channel
17770+ type: boolean
17771+ x-stream-index: "012"
17772+ mentioned_group_ids:
17773+ description: IDs of the user groups mentioned in the message
17774+ items:
17775+ type: string
17776+ title: Mentioned group IDs
17777+ type: array
17778+ x-stream-index: "011"
17779+ mentioned_here:
17780+ description: Whether the message mentions the online channel members
17781+ title: Mentioned here
17782+ type: boolean
17783+ x-stream-index: "013"
17784+ mentioned_roles:
17785+ description: Roles mentioned in the message
17786+ items:
17787+ type: string
17788+ title: Mentioned roles
17789+ type: array
17790+ x-stream-index: "010"
17791+ mentioned_users:
17792+ description: IDs of the users mentioned in the message
17793+ items:
17794+ type: string
17795+ title: Mentioned user IDs
17796+ type: array
17797+ x-stream-index: "009"
17798+ mml:
17799+ description: MML content of the message
17800+ title: Messaging Markup Language
17801+ type: string
17802+ x-stream-docs-page-id: mml_overview
17803+ x-stream-index: "002"
17804+ parent_id:
17805+ description: ID of parent message (thread)
17806+ title: Parent message ID
17807+ type: string
17808+ x-stream-docs-page-id: threads
17809+ x-stream-index: "006"
17810+ pin_expires:
17811+ description: Date/time the pin expires
17812+ format: date-time
17813+ title: Pin expires
17814+ type: string
17815+ x-stream-index: "017"
17816+ pinned:
17817+ description: Whether the message will be pinned when sent
17818+ title: Pinned
17819+ type: boolean
17820+ x-stream-index: "016"
17821+ poll_id:
17822+ description: Identifier of the poll to include in the message
17823+ title: Poll ID
17824+ type: string
17825+ x-stream-index: "018"
17826+ quoted_message_id:
17827+ title: ID of quoted message
17828+ type: string
17829+ x-stream-docs-page-id: threads#quote-message
17830+ x-stream-index: "008"
17831+ restricted_visibility:
17832+ description: IDs of the users the message will be visible to
17833+ items:
17834+ type: string
17835+ title: Restricted visibility
17836+ type: array
17837+ x-stream-index: "014"
17838+ shared_location:
17839+ $ref: '#/components/schemas/ScheduledMessageLocation'
17840+ description: Location shared in the message
17841+ title: Shared location
17842+ x-stream-index: "019"
17843+ show_in_channel:
17844+ description: Whether thread reply should be shown in the channel as well
17845+ title: Show in channel
17846+ type: boolean
17847+ x-stream-docs-page-id: threads
17848+ x-stream-index: "007"
17849+ silent:
17850+ description: Whether message is silent or not
17851+ title: Silent
17852+ type: boolean
17853+ x-stream-index: "015"
17854+ text:
17855+ description: Text of the message
17856+ title: Text
17857+ type: string
17858+ x-stream-index: "001"
17859+ type:
17860+ description: 'Contains type of the message. One of: regular, system'
17861+ title: Message Type
17862+ type: string
17863+ x-stream-docs-page-id: message_format#message-types
17864+ x-stream-index: "004"
17865+ required:
17866+ - text
17867+ - custom
17868+ title: Scheduled Message Content
17869+ type: object
17870+ ScheduledMessageFailedEvent:
17871+ description: Emitted when a scheduled message fails to send. scheduled_message.failure_reason
17872+ says why.
17873+ nullable: true
17874+ properties:
17875+ cid:
17876+ description: The CID of the channel the message is scheduled in
17877+ title: Channel CID
17878+ type: string
17879+ x-stream-index: 001.001.002
17880+ created_at:
17881+ description: Date/time of creation
17882+ format: date-time
17883+ title: Created at
17884+ type: string
17885+ x-stream-index: 001.001.001.003
17886+ custom:
17887+ additionalProperties: {}
17888+ type: object
17889+ x-stream-index: 001.001.001.007
17890+ received_at:
17891+ format: date-time
17892+ type: string
17893+ x-stream-index: 001.001.001.004
17894+ scheduled_message:
17895+ $ref: '#/components/schemas/ScheduledMessageResponse'
17896+ description: The scheduled message
17897+ title: Scheduled message
17898+ x-stream-index: "001.003"
17899+ type:
17900+ default: scheduled_message.failed
17901+ description: 'The type of event: "scheduled_message.failed" in this case'
17902+ title: Event Type
17903+ type: string
17904+ x-stream-index: 001.001.001.002
17905+ user:
17906+ $ref: '#/components/schemas/UserResponseCommonFields'
17907+ description: The user who scheduled the message
17908+ title: User
17909+ x-stream-index: 001.002.001
17910+ required:
17911+ - type
17912+ - created_at
17913+ - custom
17914+ - user
17915+ title: ScheduledMessageFailedEvent
17916+ type: object
17917+ x-stream-event-client-type: true
17918+ x-stream-event-doc-group: other
17919+ x-stream-is-event: true
17920+ x-stream-ws-base-event-name: VideoEvent
17921+ ScheduledMessageLocation:
17922+ description: The location a scheduled message will share
17923+ properties:
17924+ created_by_device_id:
17925+ description: The ID of the device that created the location.
17926+ title: Created by device ID
17927+ type: string
17928+ x-stream-index: "003"
17929+ end_at:
17930+ description: |-
17931+ The date when the location sharing ends.
17932+ If it's empty, it means the location sharing is static instead of live.
17933+ format: date-time
17934+ title: End at
17935+ type: string
17936+ x-stream-index: "004"
17937+ latitude:
17938+ description: The latitude of the location.
17939+ format: double
17940+ title: Latitude
17941+ type: number
17942+ x-stream-index: "001"
17943+ longitude:
17944+ description: The longitude of the location.
17945+ format: double
17946+ title: Longitude
17947+ type: number
17948+ x-stream-index: "002"
17949+ required:
17950+ - created_by_device_id
17951+ title: Scheduled Message Location
17952+ type: object
17953+ ScheduledMessageResponse:
17954+ description: A message scheduled to be sent later
17955+ properties:
17956+ cid:
17957+ description: The CID of the channel the message will be sent to
17958+ title: Channel CID
17959+ type: string
17960+ x-stream-index: "002"
17961+ created_at:
17962+ description: Date/time of creation
17963+ format: date-time
17964+ title: Created at
17965+ type: string
17966+ x-stream-index: "008"
17967+ failure_reason:
17968+ description: 'Why sending the message failed. Only set when status is failed.
17969+ One of: banned, no_permission, channel_frozen, channel_deleted, user_deleted,
17970+ moderation_blocked, hook_rejected, expired, internal_error, invalid_message'
17971+ title: Failure reason
17972+ type: string
17973+ x-stream-index: "007"
17974+ id:
17975+ description: Unique identifier of the scheduled message
17976+ title: ID
17977+ type: string
17978+ x-stream-index: "001"
17979+ message:
17980+ $ref: '#/components/schemas/ScheduledMessageContentResponse'
17981+ description: The message that will be sent
17982+ title: Message
17983+ x-stream-index: "004"
17984+ scheduled_at:
17985+ description: Date/time the message is scheduled to be sent
17986+ format: date-time
17987+ title: Scheduled at
17988+ type: string
17989+ x-stream-index: "005"
17990+ status:
17991+ description: 'Status of the scheduled message. One of: scheduled, sending,
17992+ failed, canceled, sent'
17993+ title: Status
17994+ type: string
17995+ x-stream-index: "006"
17996+ updated_at:
17997+ description: Date/time of the last update
17998+ format: date-time
17999+ title: Updated at
18000+ type: string
18001+ x-stream-index: "009"
18002+ user:
18003+ $ref: '#/components/schemas/UserResponse'
18004+ description: The user who scheduled the message
18005+ title: User
18006+ x-stream-index: "003"
18007+ required:
18008+ - id
18009+ - cid
18010+ - user
18011+ - message
18012+ - scheduled_at
18013+ - status
18014+ - created_at
18015+ - updated_at
18016+ title: Scheduled Message
18017+ type: object
18018+ ScheduledMessageSentEvent:
18019+ description: Emitted when a scheduled message is sent.
18020+ nullable: true
18021+ properties:
18022+ cid:
18023+ description: The CID of the channel the message was sent to
18024+ title: Channel CID
18025+ type: string
18026+ x-stream-index: 001.001.002
18027+ created_at:
18028+ description: Date/time of creation
18029+ format: date-time
18030+ title: Created at
18031+ type: string
18032+ x-stream-index: 001.001.001.003
18033+ custom:
18034+ additionalProperties: {}
18035+ type: object
18036+ x-stream-index: 001.001.001.007
18037+ message_id:
18038+ description: The ID of the message that was sent
18039+ title: Message ID
18040+ type: string
18041+ x-stream-index: "002"
18042+ received_at:
18043+ format: date-time
18044+ type: string
18045+ x-stream-index: 001.001.001.004
18046+ scheduled_message:
18047+ $ref: '#/components/schemas/ScheduledMessageResponse'
18048+ description: The scheduled message that was sent
18049+ title: Scheduled message
18050+ x-stream-index: "001.003"
18051+ type:
18052+ default: scheduled_message.sent
18053+ description: 'The type of event: "scheduled_message.sent" in this case'
18054+ title: Event Type
18055+ type: string
18056+ x-stream-index: 001.001.001.002
18057+ user:
18058+ $ref: '#/components/schemas/UserResponseCommonFields'
18059+ description: The user who scheduled the message
18060+ title: User
18061+ x-stream-index: 001.002.001
18062+ required:
18063+ - type
18064+ - created_at
18065+ - custom
18066+ - user
18067+ - message_id
18068+ title: ScheduledMessageSentEvent
18069+ type: object
18070+ x-stream-event-client-type: true
18071+ x-stream-event-doc-group: other
18072+ x-stream-is-event: true
18073+ x-stream-ws-base-event-name: VideoEvent
1774718074 ScreensharingSettings:
1774818075 properties:
1774918076 access_request_enabled:
@@ -23875,6 +24202,8 @@ components:
2387524202 reminder.created: '#/components/schemas/ReminderCreatedEvent'
2387624203 reminder.deleted: '#/components/schemas/ReminderDeletedEvent'
2387724204 reminder.updated: '#/components/schemas/ReminderUpdatedEvent'
24205+ scheduled_message.failed: '#/components/schemas/ScheduledMessageFailedEvent'
24206+ scheduled_message.sent: '#/components/schemas/ScheduledMessageSentEvent'
2387824207 thread.updated: '#/components/schemas/ThreadUpdatedEvent'
2387924208 user.banned: '#/components/schemas/UserBannedEvent'
2388024209 user.deactivated: '#/components/schemas/UserDeactivatedEvent'
@@ -23945,6 +24274,8 @@ components:
2394524274 - $ref: '#/components/schemas/ReminderDeletedEvent'
2394624275 - $ref: '#/components/schemas/ReminderNotificationEvent'
2394724276 - $ref: '#/components/schemas/ReminderUpdatedEvent'
24277+ - $ref: '#/components/schemas/ScheduledMessageFailedEvent'
24278+ - $ref: '#/components/schemas/ScheduledMessageSentEvent'
2394824279 - $ref: '#/components/schemas/ThreadUpdatedEvent'
2394924280 - $ref: '#/components/schemas/UserBannedEvent'
2395024281 - $ref: '#/components/schemas/UserDeactivatedEvent'
@@ -24216,7 +24547,7 @@ components:
2421624547 type: apiKey
2421724548info:
2421824549 title: Stream API
24219- version: v239.67.0
24550+ version: v239.67.1
2422024551openapi: 3.0.3
2422124552paths:
2422224553 /app:
0 commit comments