Package io.getstream.models
package io.getstream.models
-
ClassesClassDescriptionAccept a feed member request Accepts a pending feed member requestAccept a follow request Accepts a pending follow request.Emitted when an activity is added to a feed.Emitted when an activity is deleted.Emitted when activity feedback is provided.Provide feedback on an activity Submit feedback for an activity including options to show less, hide, report, or mute the userResponse for activity feedback submissionEmitted when activities are marked as read, seen, or watched.Emitted when an activity is pinned.Emitted when a reaction is added to an activity.Emitted when a reaction is deleted from an activity.Emitted when a reaction is updated on an activity.Emitted when an activity is removed from a feed.Emitted when an activity is restored.Emitted when an activity is unpinned.Emitted when an activity is updated.Add reaction Adds a reaction to an activityAdd a single activity Create a new activity or update an existing oneAdd bookmark Adds a bookmark to an activityAdd comment bookmark Adds a bookmark to a commentAdd comment reaction Adds a reaction to a commentAdd a comment or reply Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate eventsAdd multiple comments in a batch Adds multiple comments in a single request.Add targets to a segment Add targets to a segmentAdd user group members Adds members to a user group.Response for adding members to a user groupAnalyze Moderate named text fields and raw image bytes via multipart/form-data.This event is sent when an appeal is acceptedThis event is sent when an appeal is createdThis event is sent when an appeal is rejectedAppeal against the moderation decision Appeal against the moderation decisionAn attachment is a message object that represents a file uploaded by a user.Config for creating Azure Blob Storage storageConfiguration for ban moderation actionBan informationBan Ban a user from a channel or the entire appBatch query activity reactions Returns a single user's reactions across a set of activity IDs, without activity payloadsBasic response informationBatch query comment reactions Returns a single user's reactions across a set of comment IDs, without comment payloadsBasic response informationConfiguration for block actionThis event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.Block list contains restricted wordsBlock user on a call Block a user, preventing them from joining the call until they are unblocked.BlockUserResponse is the payload for blocking a user.Block user Block usersEmitted when a user bookmarks an activity.Emitted when a user deletes a bookmark from an activity.Emitted when a bookmark folder is deleted.Emitted when a bookmark folder is updated.Emitted when a user updates a bookmark.BroadcastSettingsResponse is the payload for broadcasting settingsBulk action appeals Process multiple appeals in a single request by applying the specified action to each.Bulk delete moderation action configs Delete multiple moderation action config entries by UUID in a single request.Bulk image moderation Moderate multiple images in bulk using a CSV fileBulk create or update moderation action configs Create or update multiple moderation action config entries in a single request.Bypass Moderation Enable or disable moderation bypass for a user.This event is sent when a user accepts a notification to join a call.CallClosedCaption represents a closed caption of a call.This event is sent when call closed captions has failedThis event is sent when call closed caption has startedThis event is sent when call closed captions has stoppedThis event is sent when a call is created.This event is sent when a call is deleted.This event is sent asynchronously when a single DTMF digit is received from a SIP participant.This event is sent when a call is mark as ended for all its participants.This event is sent when frame recording has failedThis event is sent when a frame is captured from a callThis event is sent when frame recording has startedThis event is sent when frame recording has stoppedThis event is sent when HLS broadcasting has failedThis event is sent when HLS broadcasting has startedThis event is sent when HLS broadcasting has stoppedCallIngressResponse is the payload for ingress settingsThis event is sent when a call is started.This event is sent when one or more members are added to a callThis event is sent when one or more members are removed from a callThis event is sent when one or more members are updatedThis event is sent when one or more members get its role updatedThis event is sent to call members who did not accept/reject/join the call to notify they missed the callThis event is sent when a moderation blur action is applied to a user's video streamThis event is sent when a moderation warning is issued to a userThis event is sent to all call members to notify they are getting calledThis event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screenCallRecording represents a recording of a call.This event is sent when call recording has failedThis event is sent when call recording is readyThis event is sent when call recording has startedThis event is sent when call recording has stoppedThis event is sent when a user rejects a notification to join a call.CallRequest is the payload for creating a call.Represents a callThis event is sent to all call members to notify they are getting calledThis event is sent when a call RTMP broadcast has failedThis event is sent when RTMP broadcast has startedThis event is sent when RTMP broadcast has stoppedThis event is sent when a call session endsThis event is sent when the participant counts in a call session are updatedThis event is sent when a participant joins a call sessionThis event is sent when a participant leaves a call sessionThis event is sent when a call session startsCallStateResponseFields is the payload for call state responseThis event is sent when the insights report is readyCallTranscription represents a transcription of a call.This event is sent when call transcription has failedThis event is sent when call transcription is readyThis event is sent when call transcription has startedThis event is sent when call transcription has stoppedCallTypeResponse is the payload for a call type.This event is sent when a call is updated, clients should use this update the local state of the call.This event is sent when a user submits feedback for a call.This event is sent when a call member is mutedCancel import v2 task Requests a controlled stop of an import v2 task.Basic response informationCast vote Cast a vote on a poll Sends events: - feeds.poll.vote_casted - feeds.poll.vote_changed - feeds.poll.vote_removed - poll.vote_casted - poll.vote_changed - poll.vote_removedChange a feed's visibility Changes the visibility of an existing feed.Update channels in batch Update channels in batch.Channel configuration overridesSlim channel object: identity plus creatorEmitted when a channel is successfully created.Emitted when a channel is successfully deleted.Emitted when a channel is successfully frozen.Emitted when a channel is successfully hidden.Response containing channel and its messagesEmitted when a channel is successfully muted.All possibility of string to useRepresents channel in chatEmitted when a channel is successfully truncated.Emitted when a channel is successfully unfrozen.Emitted when a channel is successfully unmuted.Emitted when a channel is successfully updated.Emitted when a channel is successfully shown.Check External StorageBasic response informationCheck push Sends a test message via push, this is a test endpoint to verify your push settingsCheck Run moderation checks on the provided contentCheck S3 image access Verifies that the configured IAM role ARN can access private S3 images for moderation.Check SNS Validates Amazon SNS configurationCheck SQS Validates Amazon SQS credentialsA single client-side telemetry event.This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screenCollect user feedback Sends events: - call.user_feedback_submittedBasic response informationRepresents custom chat commandEmitted when a comment is added to an activity.Emitted when a comment is deleted.Emitted when a reaction is added to a comment.Emitted when a reaction is deleted from a comment.Emitted when a reaction is updated on a comment.Emitted when a soft-deleted comment is restored.Emitted when a comment is updated.Commit message Commits a pending message, which will make it visible in the channel Sends events: - message.new - message.updatedChannel configuration overridesGeographic coordinatesCreate block list Creates a new application blocklist, once created the blocklist can be used by any channel typeBasic response informationCreate Call TypeResponse for creating a call typeCreate campaign Creates a campaignBasic response informationCreate channel type Creates new channel typeBasic response informationCreate multiple collections Create new collections in a batch operation.Create command Creates custom chat commandCreate device Adds a new device to a user, if the same device already exists the call will have no effectCreate external storage Creates new external storageBasic response informationCreate a new feed group Creates a new feed group with the specified configurationCreate multiple feeds at once Create multiple feeds at once for a given feed groupCreate a new feed view Create a custom view for a feed group with specific selectors, ranking, or aggregation optionsCreate GuestCreate import Creates a new importBasic response informationCreate import URL Creates a new import URLBasic response informationCreate import v2 task Creates a new import v2 taskBasic response informationCreate membership level Create a new membership level with tag-based access controlsCreate permission Creates permissionCreate policy test set Save a labeled set of messages that can be re-run against the moderation policy.Create poll option Creates a poll option Sends events: - feeds.poll.updated - poll.updatedCreate poll Creates a new pollCreate predefined filter Create a predefined filter that can be used in Query endpointsCreate queueCreate reminder Creates a new reminder.Basic response informationCreate role Creates custom roleBasic response informationCreate segment Create a segmentBasic response informationCreate SIP Inbound Routing Rule Create a new SIP Inbound Routing Rule with either direct routing or PIN routing configurationCreate SIP Trunk Create a new SIP trunk for the applicationResponse containing the created SIP trunkCreate user group Creates a new user group, optionally with initial membersResponse for creating a user groupConfiguration for custom moderation actionCustom check endpoint Custom check, add your own AI model reports to the review queueA custom event, this event is used to send custom events to other participants in the call.Metric value for a specific dateDeactivate user Deactivates user with possibility to activate it back Sends events: - user.deactivatedDeactivate users Deactivate users in batches Sends events: - user.deactivatedBasic response informationDelete a moderation action config Delete a specific moderation action config entry by its UUID.Remove multiple activities Delete one or more activities by their IDsRemove reaction Removes a reaction from an activityDelete a single activity Delete a single activity by its IDConfiguration for activity deletion actionDelete block list Deletes previously created application blocklistDelete a bookmark folder Delete a bookmark folder by its IDDelete a bookmark Deletes a bookmark from an activityDelete Call Sends events: - call.deletedDeleteCallResponse is the payload for deleting a call.Delete Call TypeDelete campaign Delete campaignBasic response informationDelete file Deletes previously uploaded fileDelete image Deletes previously uploaded imageDelete channel Deletes channel Sends events: - channel.deletedBasic response informationDeletes channels asynchronously Allows to delete several channels at once asynchronously Sends events: - channel.deletedDelete channel type Deletes channel typeDelete multiple collections Delete collections in a batch operation.Delete command Deletes custom chat commandDelete a comment bookmark Deletes a bookmark from a commentDelete comment reaction Deletes a reaction from a commentDelete a comment Deletes a comment from an object (e.g., activity) and broadcasts appropriate eventsConfiguration for comment deletion actionDelete a moderation policy Delete a specific moderation policy by its nameDelete device Deletes one deviceDelete draft Deletes a draft Sends events: - draft.deletedDelete external storage Deletes external storageBasic response informationDelete a feed group Delete a feed group by its ID.Basic response informationDelete a single feed Delete a single feed by its IDDelete multiple feeds Delete multiple feeds by their IDs.Basic response informationDelete all feed data for a user Delete all feed data for a user including: feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the userResponse for deleting feed user dataDelete a feed view Delete an existing custom feed viewDelete file Deletes previously uploaded fileDelete image Deletes previously uploaded imageDelete external storage Removes the external storage configuration for the app.Delete import v2 task Deletes an import v2 task.Basic response informationDelete membership level Delete a membership level by its UUID.Delete message Deletes message Sends events: - message.deletedConfiguration for message deletion actionBasic response informationDelete moderation rule Delete an existing moderation ruleBasic response informationDelete permission Deletes custom permissionDelete policy test setDelete poll option Deletes a poll option Sends events: - feeds.poll.updated - poll.updatedDelete poll Deletes a poll Sends events: - feeds.poll.deleted - poll.deletedDelete vote Delete a vote from a poll Sends events: - feeds.poll.vote_removed - poll.vote_removedDelete predefined filter Delete a predefined filter by nameDelete a push provider Delete a push provider from v2 with multi bundle/package support.Delete queueDelete reaction Removes user reaction from the message Sends events: - reaction.deletedConfiguration for reaction deletion actionBasic response informationDelete recording Deletes recordingResponse for DeleteRecordingDelete reminder Deletes a user's created reminder Sends events: - reminder.deletedBasic response informationDelete retention policy Removes a retention policy for the app.Basic response informationDelete role Deletes custom roleDelete segment Delete a segmentDelete targets from a segment Delete targets from a segmentDelete SIP Inbound Routing Rule Delete a SIP Inbound Routing Rule for the applicationResponse confirming SIP Inbound Routing Rule deletionDelete SIP Trunk Delete a SIP trunk for the applicationResponse confirming SIP trunk deletionDelete transcription Deletes transcriptionDeleteTranscriptionResponse is the payload for deleting a transcription.Delete user group Deletes a user group and all its membersRemove interests from a user Removes the given interest tags from a user, whether they were set manually or computed from reactions.The user's remaining interest tags, ordered by descending weight, then manually set tags before computed ones, then descending count, then ascending tag nameConfiguration for deleting all of a user's chat messages without banning them or deleting their accountConfiguration for user deletion actionDelete Users Deletes users and optionally all their belongings asynchronously.Response for DeviceContains the draft message contentEncryptionSettings is the payload for end-to-end encryption settingsEnd call Sends events: - call.endedResponse for ending a callOptions to skip specific enrichments to improve performance.Ephemeral message update Updates message fields without storing in database, only sends update event Sends events: - message.updatedConfiguration for escalation actionBasic response informationExport channels Exports channel data to a JSON or CSV file (CSV requires version=v2)Export all feed data for a user Export all feed data for a user including: user profile, feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the userResponse for exporting feed user dataExport user Exports the user's profile, reactions and messages.Export users Exports user profile, reactions and messages for list of given usersBasic response informationEmitted when a feed is created.Emitted when a feed is deleted.Emitted when a feed group is changed.Emitted when a feed group is deleted.Emitted when a feed group is restored.Emitted when a feed member is added.Emitted when a feed member is removed.Emitted when a feed member is updated.Represents a feed capability value and enumerates all possible capability strings.Delete feeds retention policy Removes the feeds retention policy for the app.Get feeds retention policy Returns the feeds retention policies configured for the app.Get feeds retention policy runs Returns filtered and sorted feeds retention cleanup run history for the app.Configuration for a feeds moderation templateSet feeds retention policy Creates or updates the feeds retention policy for the app.Emitted when a feed is updated.Flag content for moderation Flag any type of content (messages, users, channels, activities) for moderation review.Create multiple follows at once Creates multiple follows at once and broadcasts FollowAddedEvent for each followEmitted when a feed follows another feed.Emitted when a feed unfollows another feed.Create a follow Creates a follow and broadcasts FollowAddedEventEmitted when a follow relationship is updated.Options to control fetching reactions from friends (users you follow or have mutual follows with).Get moderation action configs Returns moderation action configs grouped by entity type, sorted by order ascending.Get active calls status Get the current status of all active calls including metrics and summary informationResponse containing active calls status informationGet activity Returns activity by IDGet appeal item Retrieve a specific appeal item by its IDBasic response informationGet App Settings This Method returns the application settingsGet list of blocked Users Get list of blocked UsersGet block list Returns block list by given nameResponse for get block listGet call participant session metricsBasic response informationGet call reportBasic response informationGet CallGet call session participant stats detailsBasic response informationGet participant timeline eventsMap call participants by locationGet Call TypeGet campaign Get campaign by ID.Basic response informationGet channel Returns a channel by its CID without creating it.Get channel type Gets channel typeBasic response informationGet command Returns custom command by its nameGet replies for a comment Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and paginationGet comment Get a comment by IDGet comments for an object Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and paginationGet moderation configuration Retrieve a specific moderation configuration by its key and team.Basic response informationGet daily digest Returns the app's per-broadcast daily digest bundle for one UTC day, with an explicit readiness status (ready, pending, failed, future_date, expired).Basic response informationGet draft Get a draftBasic response informationGet Edges Returns the list of all edges available for video calls.Basic response informationBasic response informationGet feed counts Returns the number of activities in a feed, the total number of comments on those activities (including nested replies), and the sum of both.Get a feed group Get a feed group by IDGet Feeds Rate Limits Retrieve current rate limit status for feeds operations.Basic response informationBasic response informationGet a feed view Get a feed view by its IDGet feed visibility Gets feed visibility configuration and permissionsGet flag count for a user Returns the number of moderation flags created against a specific user's content.Get follow suggestions Get follow suggestions for a feed groupGet external storage Returns the current external storage configuration for the app.Get import Gets an importBasic response informationGet import v2 task Gets a single import v2 task by IDBasic response informationGet many messages Returns list messages found by IDsGet message Returns message by IDBasic response informationGet moderation rule Get a specific moderation rule by IDBasic response informationGet OG Get an OpenGraph attachment for a linkGet or create a call Gets or creates a new call Sends events: - call.created - call.notification - call.ringGet or create channel This Method creates a channel or returns an existing one with matching attributes Sends events: - channel.created - member.added - member.removed - member.updated - user.watching.startGet or create channel This Method creates a channel or returns an existing one with matching attributes Sends events: - channel.created - member.added - member.removed - member.updated - user.watching.startGet or create a feed group Get an existing feed group or create a new one if it doesn't existCreate a new feed Create a single feed for a given feed groupBasic response informationGet or create a feed view Get an existing feed view or create a new one if it doesn't existUpsert a follow Creates a follow if it does not exist, or returns the existing one.Upsert multiple follows at once Creates or updates multiple follows at once.Unfollow a feed (idempotent) Removes a follow and broadcasts feeds.follow.deleted (FollowDeletedEvent).Unfollow multiple feeds (idempotent) Removes multiple follows and broadcasts FollowRemovedEvent for each.Get permission Gets custom permissionGet pinned messages Returns pinned messages for the channelGet policy test runGet policy test setGet poll option Retrieves a poll optionGet poll Retrieves a pollGet predefined filter Get a predefined filter by nameGet predefined filters Get all predefined filters with optional sorting by created_at, updated_at, name, or operationGet push notification templates Retrieve push notification templates for Chat.Basic response informationGet queueGet rate limits Get rate limits usage and quotasGet reactions Returns list of reactions of specific messageGet replies Returns replies (thread) of the messageBasic response informationGet retention policy Returns all retention policies configured for the app.Basic response informationGet retention policy runs Returns filtered and sorted retention cleanup run history for the app.Basic response informationGet review queue item Retrieve a specific review queue item by its IDGet segment Get segmentGet moderation setup session Retrieve a setup session for an appGet status of a task Gets status of a taskGet Thread Return a specific threadGet user group Gets a user group by ID, including its membersResponse for getting a user groupGet a user's interests Returns the user's interest tags with their ranking weights: tags computed from the activities the user reacted to and tags set manually through the API.User's interest tags ordered by descending weight, then manually set tags before computed ones, then descending count, then ascending tag nameGet user live locations Retrieves all active live locations for a userSet call as live Sends events: - call.live_startedBasic response informationGrouped query channels Query channels grouped into predefined buckets.Hide channel Marks channel as hidden for current user Sends events: - channel.hiddenBasic response informationHLSSettings is the payload for HLS settingsImport block list items Enqueues an asynchronous bulk import of items into an existing blocklist.Basic response informationThis event is sent when a critical error occurs that breaks the streaming pipelineThis event is sent when a user begins streaming into a callThis event is sent when streaming stops due to user action or call endedInsert moderation action log Insert a moderation action log entry.Response after inserting a moderation action logThis event is sent when a buffered conversation's intent score clears the configured thresholdAn interest tag of a user with its ranking weight and, for computed tags, how many distinct reacted-to activities carried itThis event is sent to call participants to notify when a user is kicked from a call.Kick user from a call Kicks a user from the call.KickUserResponse is the payload for kicking a user from a call.Labels Run moderation on text and return labelsBasic response informationList block lists Returns all available block listsResponse for ListCallTypeList Call TypeList channel types Lists all available channel typesList commands Returns all custom commandsList devices Returns all available devicesList devices responseList external storage Lists external storageBasic response informationList all feed groups List all feed groups for the applicationBasic response informationList all feed views List persisted feed views for the application.List feed visibilities Gets all available feed visibility configurations and their permissionsGet import Gets an importBasic response informationList import v2 tasks Lists all import v2 tasks for the appBasic response informationList permissions Lists all available permissionsBasic response informationList policy test setsList push providers List details of all push providers.Basic response informationList queuesBasic response informationList recordings Lists recordingsResponse for listing recordingsList roles Lists all available rolesBasic response informationList SIP Inbound Routing Rules List all SIP Inbound Routing Rules for the applicationResponse containing the list of SIP Inbound Routing RulesList SIP Trunks List all SIP trunks for the applicationResponse containing the list of SIP trunksList transcriptions Lists transcriptionsList user groups Lists user groups with cursor-based paginationResponse for listing user groupsGeographic location metadataMark activities as read/seen/watched Mark activities as read/seen/watched.Mark channels as read Marks channels as read up to the specific message.Mark channel message delivery status Mark the status of a channel message delivered.Basic response informationMark read Marks channel as read up to the specific message Sends events: - message.readConfiguration for mark reviewed actionMark unread Marks channel as unread from a specific messageEmitted when a member is added to a channel.Emitted when a member is removed from a channel.MemberRequest is the payload for adding a member to a call.MemberResponse is the payload for a member of a call.Emitted when a member is updated in a channel.Basic response informationEmitted when a message is deleted.This event is sent when a message gets flagged.Result of the message moderationEmitted when a message was successfully sent or when a message became visible after command execution.Emitted when a channel or thread is marked as read.Message data for creating or updating a messageRepresents any chat messageEmitted when a message is unblocked.Emitted when a message is undeleted.Emitted when a BaseEvent is updated with translation data or when a message is updated.Represents any chat messageStatistics for a single metric with optional daily breakdownConfiguration for a moderation actionAn /analyze call was acknowledged but its moderation could not be completed, so no verdict exists for the content.This event is sent when a moderation check is completedThis event is sent when a custom moderation action is executedThis event is sent when content is flagged for moderationPer-image moderation verdict from /analyze.This event is sent when a moderation item is marked as reviewedContent payload for moderationContent payload for moderationThis event is sent automatically whenever a rule builder rule is triggeredPer-text moderation verdict from /analyze.Mute channel Mutes channel for user Sends events: - channel.mutedMute Mute a user.Mute users Mutes users in a callMuteUsersResponse is the response payload for the mute users endpoint.Emitted when notification feed is updated.Emitted when a channel/thread is marked as unread.Emitted when a new message was sent to a thread.Get own fields for multiple feeds Retrieves own_follows, own_capabilities, and/or own_membership for multiple feeds in a single request.All possibility of string to usePending message event for async moderationThis event is sent when a user requests access to a feature on a call, clients receiving this event should display a permission request to the userPin an activity to a feed Pin an activity to a feed.PinRequest is the payload for pinning a message.Basic response informationPolicy requestQuery activities Query activities based on filters with pagination and sorting optionsQuery activity reactions Query activity reactionsBasic response informationQuery activity shares List the shares recorded for an activity, newest-firstBasic response informationQuery Aggregate call StatsBasic response informationQuery Appeals Query AppealsQuery Banned Users Find and filter channel scoped or global user bansQuery bookmark folders Query bookmark folders with filter queryQuery bookmarks Query bookmarks with filter queryQuery call members Query call members with filter queryBasic response informationQuery call participant sessionsBasic response informationQuery call participants Returns a list of participants connected to the callQuery call participant statisticsBasic response informationBasic response informationQuery call session statsBasic response informationQuery call Query calls with filter queryBasic response informationQuery Call StatsBasic response informationQuery campaigns Query campaigns with filter queryBasic response informationQuery channels Query channels with filter queryQuery collections Query collections with filter queryQuery comment reactions Query comment reactionsBasic response informationQuery comments Query comments using MongoDB-style filters with pagination and sorting optionsQuery draft messages Queries draft messages for a userQuery feed members Query feed members based on filters with pagination and sorting optionsQuery feeds Query feeds with filter queryQuery Feed Usage Statistics Retrieve usage statistics for feeds including activity count, follow count, and API request count.Query follows Query follows based on filters with pagination and sorting optionsQuery Future Channel Bans Find and filter future channel bans created by the authenticated userQuery label results Search and filter moderation label results with support for pagination and sorting.Query membership levels Query membership levels with filter queryQuery members Find and filter channel membersQuery Message Flags Find and filter message flagsQuery message flags responseQuery message history Queries history for one messageQuery moderation configurations Search and filter moderation configurations across your application.Query moderation flags Query flags associated with moderation items.Basic response informationQuery moderation action logs Search and filter moderation action logs with support for pagination.Query moderation rules Search and filter moderation rules across your application.Query pinned activities Query pinned activities for a feed with filter queryQuery polls Queries pollsQuery votes Queries votesGet reactions on a messageBasic response informationQuery reminders Queries remindersQuery review queue items Query review queue items allows you to filter the review queue items.Query revision history Queries revision history for activities and commentsQuery segments Query segmentsQuery segment targets Query segment targetsQuery Team Usage Statistics Retrieve team-level usage statistics from the warehouse database.Response containing team-level usage statisticsQuery Threads Returns the list of threads for specific userQuery user reported feedback for the callsBasic response informationQuery users Find and filter usersBasic response informationEmitted when a reaction is deleted from a message.ReactionGroupResponse contains all information about a reaction of the same type.Contains information about a user who reacted with this reaction type.Emitted when a new reaction is added to a message.Represents user reaction to a messageEmitted when a reaction is updated on a message.Reactivate user Activates user who's been deactivated previously Sends events: - user.reactivatedReactivate users Reactivate users in batches Sends events: - user.reactivatedBasic response informationRead collections Read collections by their references.RecordSettings is the payload for recording settingsConfiguration for rejecting an appealReject an invite to become a feed member Rejects a pending feed member requestReject a follow request Rejects a pending follow requestEmitted when a reminder is created.Emitted when a reminder is deleted.Emitted when a reminder becomes due, triggering a notification for the user.Emitted when a reminder is updated.Remove user group members Removes members from a user group.Response for removing members from a user groupCursor & depth information for a comment's direct replies.Report client-side events Reports a batch of client-side telemetry events.Reports a batch of client-side telemetry events.Response for reporting client-side telemetry eventsResolve SIP Auth Determine authentication requirements for an inbound SIP call before sending a digest challengeResponse containing the pre-authentication decision for a SIP trunkResolve SIP Inbound Routing Resolve SIP inbound routing based on trunk number, caller number, and challenge authenticationResponse containing resolved SIP inbound routing informationBasic response informationConfiguration for restore action.Restore an activity Restores a soft-deleted, moderation-removed, or shadow-blocked activity by its ID.Restore a comment Restores a soft-deleted, moderation-removed, or shadow-blocked comment by its ID.Restore a feed group Restores a soft-deleted feed group by its ID.Restore users Restore soft deleted usersThis event is sent when a new moderation review queue item is createdThis event is sent when a moderation review queue item is updatedRing Call Users Sends a ring notification to the provided users who are not already in the call.RTMPBroadcastRequest is the payload for starting an RTMP broadcast.RTMP input settingsRTMPSettingsResponse is the payload for RTMP settingsRun message command action Executes message command action with given parameters Sends events: - message.newConfig for creating Amazon S3 storage.Search messages Search messages across channelsSearch roles Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocompleteSearch user groups Searches user groups by name prefix for autocompleteResponse for searching user groupsCheck whether a target exists in a segment Check whether a target exists in a segment.Send custom event Sends custom event to the call Sends events: - customSend closed caption Sends a closed caption event to the call Sends events: - call.closed_captionSend event Sends event to the channelSend new message Sends new message to the specified channel Sends events: - channel.visible - message.new - message.updatedSend reaction Sends reaction to specified message Sends events: - reaction.new - reaction.updatedBasic response informationSend user event Sends a custom event to a user Sends events: - *Basic response informationSet retention policy Creates or updates a retention policy for the app.Basic response informationConfiguration for shadow block actionShow channel Shows previously hidden channel Sends events: - channel.visibleBasic response informationConfiguration for SIP call settingsSIP call configuration responseConfiguration for SIP caller settingsSIP caller configuration responseSIP digest challenge authentication dataConfiguration for direct routing rule callsDirect routing rule call configuration responseCredentials for SIP inbound call authenticationConfiguration for PIN routing rule callsPIN routing rule call configuration responseRequest to create or update a SIP Inbound Routing RuleSIP Inbound Routing Rule responseConfiguration for PIN protection settingsPIN protection configuration responseSIP trunk informationStart/schedule campaign Starts or schedules a campaignBasic response informationStart closed captions Starts closed captionsStart frame recording Starts frame by frame recording Sends events: - call.frame_recording_startedStartFrameRecordingResponse is the response payload for the start frame recording endpoint.Start HLS broadcasting Starts HLS broadcastingStartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.Start policy test run Enqueue a background run of the set against the saved live moderation config.Start recording Starts recording Sends events: - call.recording_startedStartRecordingResponse is the response payload for the start recording endpoint.Start RTMP broadcasts Starts RTMP broadcasts for the provided RTMP destinationsStartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.Start transcription Starts transcriptionStop all RTMP broadcasts for a call Stop all RTMP broadcasts for the provided callStop campaign Stops a campaignStop closed captions Stops closed captions Sends events: - call.transcription_stoppedBasic response informationStop frame recording Stops frame recording Sends events: - call.frame_recording_stoppedBasic response informationStop HLS broadcasting Stops HLS broadcastingBasic response informationSet call as not live Sends events: - call.updatedStop recording Stops recording Sends events: - call.recording_stoppedBasic response informationStop RTMP broadcasts Stop RTMP broadcasts for the provided RTMP destinationsRequest for stopping RTMP broadcastsBasic response informationStop transcription Stops transcription Sends events: - call.transcription_stoppedBasic response informationEmitted when stories feed is updated.Submit moderation action Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions.Submit moderation feedback Forward a moderator-supplied correction to the moderation feedback pipeline.Usage statistics for a single team containing all 16 metricsA comment with an optional, depth‑limited slice of nested replies.Represents a user that is participating in a thread.Sets thresholds for AI moderationA single metric event to track for an activityResult of tracking a single metric eventTrack activity metrics Track metric events (views, clicks, impressions) for activities.Response containing results for each tracked metric eventTranslate activity Translates an activity's text to a given language using automated translation Sends events: - feeds.activity.updatedBasic response informationTranslate comment Translates a comment's text to a given language using automated translation Sends events: - feeds.comment.updatedBasic response informationTranslate message Translates message to a given language using automated translation software Sends events: - message.updatedBasic response informationTruncate channel Truncates messages from a channel.Configuration for unban moderation actionUnban Unban a user from a channel or globally.Deprecated: Use restore instead, which now also reverses a block or shadow block.This event is sent when a user is unblocked on a call, this can be useful to notify the user that they can now join the call againUnblocks user on a call Removes the block for a user on a call.UnblockUserResponse is the payload for unblocking a user.Unblock user Unblock usersUndelete message Undelete a message that was previously soft-deleted Sends events: - message.undeletedBasic response informationUnfollow multiple feeds at once Removes multiple follows at once and broadcasts FollowRemovedEvent for each oneUnfollow a feed Removes a follow and broadcasts FollowRemovedEventUnmute channel Unmutes channel for user Sends events: - channel.unmutedUnmute a user Unmute a userUnpin an activity from a feed Unpin an activity from a feed.UnpinRequest is the payload for unpinning a message.UnpinResponse is the payload for unpinning a message.Batch unread counts Fetch unread counts in batch for multiple users in one callBasic response informationUnread counts Fetch unread counts for a single userBatch partial activity update Updates certain fields of multiple activities in a batch.Partial activity update Updates certain fields of the activity.Full activity update Replaces an activity with the provided data.Update App Settings This Method updates one or more application settingsUpdate block list Updates contents of the block listBasic response informationUpdate a bookmark folder Update a bookmark folder by its IDUpdate bookmark Updates a bookmark for an activityUpdate Call Member Sends events: - call.member_added - call.member_removed - call.member_updatedBasic response informationUpdate Call Sends events: - call.updatedResponse for updating a callUpdate Call TypeUpdateCallTypeResponse is the payload for updating a call type.Update campaign Updates a campaignPartially update channel Updates certain fields of the channel Sends events: - channel.updatedUpdate channel Change channel data Sends events: - channel.updated - member.added - member.removed - member.updated - message.newUpdate channel type Updates channel typeBasic response informationUpdate multiple collections Update existing collections in a batch operation.Update command Updates custom chat commandUpdate comment bookmark Updates a bookmark for a commentPartial comment update Updates certain fields of the comment.Update a comment Updates a comment on an object (e.g., activity) and broadcasts appropriate eventsThis event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordinglyUpdate External StorageBasic response informationUpdate a feed group Update a feed group by IDUpdate feed members Add, remove, or set members for a feedBasic response informationUpdate a feed Update an existing feedUpdate a feed view Update an existing custom feed view with new selectors, ranking, or aggregation optionsUpdate Feed Visibility Updates an existing predefined feed visibility configurationUpdate a follow Updates a follow's custom data, push preference, and follower role.Update live location Updates an existing live location with new coordinates or expiration timePartially channel member updateUpdate membership level Update a membership level with partial updates.Partially message update Updates certain fields of the message Sends events: - message.updatedUpdate message Updates message with new data Sends events: - message.updatedBasic response informationUpdate permission Updates custom permissionUpdate poll option Updates a poll option Sends events: - feeds.poll.updated - poll.updatedPartial update poll Updates a poll partially Sends events: - feeds.poll.closed - feeds.poll.updated - poll.closed - poll.updatedUpdate poll Updates a poll Sends events: - feeds.poll.closed - feeds.poll.updated - poll.closed - poll.updatedUpdate predefined filter Update a predefined filter by namePush notification preferences Upserts the push preferences for a user and or channel member.Update queueUpdates Reminder Updates an existing reminder.Basic response informationUpdate segment Update an existing segmentUpdate SIP Inbound Routing Rule Update an existing SIP Inbound Routing Rule with new configurationResponse containing the updated SIP Inbound Routing RuleUpdate SIP Trunk Update a SIP trunk for the applicationResponse containing the updated SIP trunkPartially update thread Updates certain fields of the thread Sends events: - thread.updatedUpdate user group Updates a user group's name and/or description.Response for updating a user groupUpdate user permissions Updates user permissions Sends events: - call.permissions_updatedBasic response informationPartially update user Updates certain fields of the user Sends events: - user.presence.changed - user.updatedUpsert users Update or create users in bulk Sends events: - user.updatedUpload file Uploads fileUpload image Uploads imageUpload file Uploads fileUpload image Uploads imageCreate or update a moderation action config Create a new moderation action config entry or update an existing one.Upsert multiple activities Create new activities or update existing ones in a batch operationUpsert multiple collections Insert new collections or update existing ones in a batch operation.Create or update moderation configuration Create a new moderation configuration or update an existing one.Basic response informationUpsert external storage Creates or updates the external storage configuration for the app.Upsert moderation rule Create or update a moderation rule that can apply app-wide or to specific moderation configsBasic response informationUpsert a push provider Upsert a push provider for v2 with multi bundle/package supportBasic response informationUpsert a push notification template Create or update a push notification template for a specific event type and push providerBasic response informationCreate or update moderation setup session Update a setup session for an appSet a user's interests Adds or updates interest tags on a user with explicit ranking weights.The user's interest tags after the write, ordered by descending weight, then manually set tags before computed ones, then descending count, then ascending tag nameThis event is sent when a user gets banned.This event is sent when a user gets deactivated.This event is sent when a user gets deleted.This event is sent when a user gets flagged.Emitted when a user group is created.Emitted when a user group is deleted.Emitted when members are added to a user group.Emitted when members are removed from a user group.Emitted when a user group is updated.An interest tag to set on a user with its ranking weightThis event is sent when a user's message get deleted.This event is sent when a user gets muted.This event is sent when a user gets reactivated.User request objectUser response objectThis event is sent when a user gets unbanned.This event is sent when a user gets unmuted.Reminder events allow you to notify your users about unread messages.This event is sent when a user gets updated.Delete a moderation template Delete a specific moderation template by its nameQuery feed moderation templates Retrieve a list of feed moderation templates that define preset moderation rules and configurations.Upsert feeds template Upsert feeds template for moderationBasic response informationValidate external storage Validates the configured external storage.Configuration for ending video callConfiguration for kicking user from video callPin Pins a track for all users in the call.Unpin Unpins a track for all users in the call.The discriminator object for all webhook events, it maps events' payload to the final typeBasic response informationRepresents an BaseEvent that happened in Stream Chat