All Classes and Interfaces
Class
Description
Accept a feed member request Accepts a pending feed member request
Accept 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 user
Response for activity feedback submission
Emitted 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 activity
Add a single activity Create a new activity or update an existing one
Add bookmark Adds a bookmark to an activity
Add comment bookmark Adds a bookmark to a comment
Add comment reaction Adds a reaction to a comment
Add a comment or reply Adds a comment to an object (e.g., activity) or a reply to an existing
comment, and broadcasts appropriate events
Add multiple comments in a batch Adds multiple comments in a single request.
Add targets to a segment Add targets to a segment
Add user group members Adds members to a user group.
Response for adding members to a user group
Analyze Moderate named text fields and raw image bytes via multipart/form-data.
This event is sent when an appeal is accepted
This event is sent when an appeal is created
This event is sent when an appeal is rejected
Appeal against the moderation decision Appeal against the moderation decision
An attachment is a message object that represents a file uploaded by a user.
Config for creating Azure Blob Storage storage
Configuration for ban moderation action
Ban information
Ban Ban a user from a channel or the entire app
Batch query activity reactions Returns a single user's reactions across a set of activity
IDs, without activity payloads
Basic response information
Batch query comment reactions Returns a single user's reactions across a set of comment IDs,
without comment payloads
Basic response information
Configuration for block action
This 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 words
Block 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 users
Emitted 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 settings
Bulk 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 file
Bulk 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 failed
This event is sent when call closed caption has started
This event is sent when call closed captions has stopped
This 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 failed
This event is sent when a frame is captured from a call
This event is sent when frame recording has started
This event is sent when frame recording has stopped
This event is sent when HLS broadcasting has failed
This event is sent when HLS broadcasting has started
This event is sent when HLS broadcasting has stopped
CallIngressResponse is the payload for ingress settings
This event is sent when a call is started.
This event is sent when one or more members are added to a call
This event is sent when one or more members are removed from a call
This event is sent when one or more members are updated
This event is sent when one or more members get its role updated
This event is sent to call members who did not accept/reject/join the call to notify they missed
the call
This event is sent when a moderation blur action is applied to a user's video stream
This event is sent when a moderation warning is issued to a user
This event is sent to all call members to notify they are getting called
This event is sent when a reaction is sent in a call, clients should use this to show the
reaction in the call screen
CallRecording represents a recording of a call.
This event is sent when call recording has failed
This event is sent when call recording is ready
This event is sent when call recording has started
This event is sent when call recording has stopped
This event is sent when a user rejects a notification to join a call.
CallRequest is the payload for creating a call.
Represents a call
This event is sent to all call members to notify they are getting called
This event is sent when a call RTMP broadcast has failed
This event is sent when RTMP broadcast has started
This event is sent when RTMP broadcast has stopped
This event is sent when a call session ends
This event is sent when the participant counts in a call session are updated
This event is sent when a participant joins a call session
This event is sent when a participant leaves a call session
This event is sent when a call session starts
CallStateResponseFields is the payload for call state response
This event is sent when the insights report is ready
CallTranscription represents a transcription of a call.
This event is sent when call transcription has failed
This event is sent when call transcription is ready
This event is sent when call transcription has started
This event is sent when call transcription has stopped
CallTypeResponse 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 muted
Cancel import v2 task Requests a controlled stop of an import v2 task.
Basic response information
Cast 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_removed
Change a feed's visibility Changes the visibility of an existing feed.
Update channels in batch Update channels in batch.
Channel configuration overrides
Slim channel object: identity plus creator
Emitted 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 messages
Emitted when a channel is successfully muted.
All possibility of string to use
Represents channel in chat
Emitted 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 Storage
Basic response information
Check push Sends a test message via push, this is a test endpoint to verify your push settings
Check Run moderation checks on the provided content
Check S3 image access Verifies that the configured IAM role ARN can access private S3 images for
moderation.
Check SNS Validates Amazon SNS configuration
Check SQS Validates Amazon SQS credentials
A 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 screen
Collect user feedback Sends events: - call.user_feedback_submitted
Basic response information
Represents custom chat command
Emitted 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.updated
Channel configuration overrides
Geographic coordinates
Create block list Creates a new application blocklist, once created the blocklist can be used by
any channel type
Basic response information
Create Call Type
Response for creating a call type
Create campaign Creates a campaign
Basic response information
Create channel type Creates new channel type
Basic response information
Create multiple collections Create new collections in a batch operation.
Create command Creates custom chat command
Create device Adds a new device to a user, if the same device already exists the call will have
no effect
Create external storage Creates new external storage
Basic response information
Create a new feed group Creates a new feed group with the specified configuration
Create multiple feeds at once Create multiple feeds at once for a given feed group
Create a new feed view Create a custom view for a feed group with specific selectors, ranking, or
aggregation options
Create Guest
Create import Creates a new import
Basic response information
Create import URL Creates a new import URL
Basic response information
Create import v2 task Creates a new import v2 task
Basic response information
Create membership level Create a new membership level with tag-based access controls
Create permission Creates permission
Create 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.updated
Create poll Creates a new poll
Create predefined filter Create a predefined filter that can be used in Query endpoints
Create queue
Create reminder Creates a new reminder.
Basic response information
Create role Creates custom role
Basic response information
Create segment Create a segment
Basic response information
Create SIP Inbound Routing Rule Create a new SIP Inbound Routing Rule with either direct routing
or PIN routing configuration
Create SIP Trunk Create a new SIP trunk for the application
Response containing the created SIP trunk
Create user group Creates a new user group, optionally with initial members
Response for creating a user group
Configuration for custom moderation action
Custom check endpoint Custom check, add your own AI model reports to the review queue
A custom event, this event is used to send custom events to other participants in the call.
Metric value for a specific date
Deactivate user Deactivates user with possibility to activate it back Sends events: -
user.deactivated
Deactivate users Deactivate users in batches Sends events: - user.deactivated
Basic response information
Delete a moderation action config Delete a specific moderation action config entry by its UUID.
Remove multiple activities Delete one or more activities by their IDs
Remove reaction Removes a reaction from an activity
Delete a single activity Delete a single activity by its ID
Configuration for activity deletion action
Delete block list Deletes previously created application blocklist
Delete a bookmark folder Delete a bookmark folder by its ID
Delete a bookmark Deletes a bookmark from an activity
Delete Call Sends events: - call.deleted
DeleteCallResponse is the payload for deleting a call.
Delete Call Type
Delete campaign Delete campaign
Basic response information
Delete file Deletes previously uploaded file
Delete image Deletes previously uploaded image
Delete channel Deletes channel Sends events: - channel.deleted
Basic response information
Deletes channels asynchronously Allows to delete several channels at once asynchronously Sends
events: - channel.deleted
Delete channel type Deletes channel type
Delete multiple collections Delete collections in a batch operation.
Delete command Deletes custom chat command
Delete a comment bookmark Deletes a bookmark from a comment
Delete comment reaction Deletes a reaction from a comment
Delete a comment Deletes a comment from an object (e.g., activity) and broadcasts appropriate
events
Configuration for comment deletion action
Delete a moderation policy Delete a specific moderation policy by its name
Delete device Deletes one device
Delete draft Deletes a draft Sends events: - draft.deleted
Delete external storage Deletes external storage
Basic response information
Delete a feed group Delete a feed group by its ID.
Basic response information
Delete a single feed Delete a single feed by its ID
Delete multiple feeds Delete multiple feeds by their IDs.
Basic response information
Delete 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 user
Response for deleting feed user data
Delete a feed view Delete an existing custom feed view
Delete file Deletes previously uploaded file
Delete image Deletes previously uploaded image
Delete external storage Removes the external storage configuration for the app.
Delete import v2 task Deletes an import v2 task.
Basic response information
Delete membership level Delete a membership level by its UUID.
Delete message Deletes message Sends events: - message.deleted
Configuration for message deletion action
Basic response information
Delete moderation rule Delete an existing moderation rule
Basic response information
Delete permission Deletes custom permission
Delete policy test set
Delete poll option Deletes a poll option Sends events: - feeds.poll.updated - poll.updated
Delete poll Deletes a poll Sends events: - feeds.poll.deleted - poll.deleted
Delete vote Delete a vote from a poll Sends events: - feeds.poll.vote_removed - poll.vote_removed
Delete predefined filter Delete a predefined filter by name
Delete a push provider Delete a push provider from v2 with multi bundle/package support.
Delete queue
Delete reaction Removes user reaction from the message Sends events: - reaction.deleted
Configuration for reaction deletion action
Basic response information
Delete recording Deletes recording
Response for DeleteRecording
Delete reminder Deletes a user's created reminder Sends events: - reminder.deleted
Basic response information
Delete retention policy Removes a retention policy for the app.
Basic response information
Delete role Deletes custom role
Delete segment Delete a segment
Delete targets from a segment Delete targets from a segment
Delete SIP Inbound Routing Rule Delete a SIP Inbound Routing Rule for the application
Response confirming SIP Inbound Routing Rule deletion
Delete SIP Trunk Delete a SIP trunk for the application
Response confirming SIP trunk deletion
Delete transcription Deletes transcription
DeleteTranscriptionResponse is the payload for deleting a transcription.
Delete user group Deletes a user group and all its members
Remove 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 name
Configuration for deleting all of a user's chat messages without banning them or deleting
their account
Configuration for user deletion action
Delete Users Deletes users and optionally all their belongings asynchronously.
Response for Device
Contains the draft message content
EncryptionSettings is the payload for end-to-end encryption settings
End call Sends events: - call.ended
Response for ending a call
Options to skip specific enrichments to improve performance.
Ephemeral message update Updates message fields without storing in database, only sends update
event Sends events: - message.updated
Configuration for escalation action
Basic response information
Export 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 user
Response for exporting feed user data
Export user Exports the user's profile, reactions and messages.
Export users Exports user profile, reactions and messages for list of given users
Basic response information
Emitted 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 template
Set 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 follow
Emitted when a feed follows another feed.
Emitted when a feed unfollows another feed.
Create a follow Creates a follow and broadcasts FollowAddedEvent
Emitted 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
information
Response containing active calls status information
Get activity Returns activity by ID
Get appeal item Retrieve a specific appeal item by its ID
Basic response information
Get App Settings This Method returns the application settings
Get list of blocked Users Get list of blocked Users
Get block list Returns block list by given name
Response for get block list
Get call participant session metrics
Basic response information
Get call report
Basic response information
Get Call
Get call session participant stats details
Basic response information
Get participant timeline events
Map call participants by location
Get Call Type
Get campaign Get campaign by ID.
Basic response information
Get channel Returns a channel by its CID without creating it.
Get channel type Gets channel type
Basic response information
Get command Returns custom command by its name
Get replies for a comment Retrieve a threaded list of replies for a single comment, with
configurable depth, sorting, and pagination
Get comment Get a comment by ID
Get comments for an object Retrieve a threaded list of comments for a specific object (e.g.,
activity), with configurable depth, sorting, and pagination
Get moderation configuration Retrieve a specific moderation configuration by its key and team.
Basic response information
Get 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 information
Get draft Get a draft
Basic response information
Get Edges Returns the list of all edges available for video calls.
Basic response information
Basic response information
Get 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 ID
Get Feeds Rate Limits Retrieve current rate limit status for feeds operations.
Basic response information
Basic response information
Get a feed view Get a feed view by its ID
Get feed visibility Gets feed visibility configuration and permissions
Get 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 group
Get external storage Returns the current external storage configuration for the app.
Get import Gets an import
Basic response information
Get import v2 task Gets a single import v2 task by ID
Basic response information
Get many messages Returns list messages found by IDs
Get message Returns message by ID
Basic response information
Get moderation rule Get a specific moderation rule by ID
Basic response information
Get OG Get an OpenGraph attachment for a link
Get or create a call Gets or creates a new call Sends events: - call.created - call.notification
- call.ring
Get 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.start
Get 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.start
Get or create a feed group Get an existing feed group or create a new one if it doesn't exist
Create a new feed Create a single feed for a given feed group
Basic response information
Get or create a feed view Get an existing feed view or create a new one if it doesn't exist
Upsert 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 permission
Get pinned messages Returns pinned messages for the channel
Get policy test run
Get policy test set
Get poll option Retrieves a poll option
Get poll Retrieves a poll
Get predefined filter Get a predefined filter by name
Get predefined filters Get all predefined filters with optional sorting by created_at,
updated_at, name, or operation
Get push notification templates Retrieve push notification templates for Chat.
Basic response information
Get queue
Get rate limits Get rate limits usage and quotas
Get reactions Returns list of reactions of specific message
Get replies Returns replies (thread) of the message
Basic response information
Get retention policy Returns all retention policies configured for the app.
Basic response information
Get retention policy runs Returns filtered and sorted retention cleanup run history for the app.
Basic response information
Get review queue item Retrieve a specific review queue item by its ID
Get segment Get segment
Get moderation setup session Retrieve a setup session for an app
Get status of a task Gets status of a task
Get Thread Return a specific thread
Get user group Gets a user group by ID, including its members
Response for getting a user group
Get 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 name
Get user live locations Retrieves all active live locations for a user
Set call as live Sends events: - call.live_started
Basic response information
Grouped query channels Query channels grouped into predefined buckets.
Hide channel Marks channel as hidden for current user Sends events: - channel.hidden
Basic response information
HLSSettings is the payload for HLS settings
Deprecated.
Import block list items Enqueues an asynchronous bulk import of items into an existing blocklist.
Basic response information
This event is sent when a critical error occurs that breaks the streaming pipeline
This event is sent when a user begins streaming into a call
This event is sent when streaming stops due to user action or call ended
Insert moderation action log Insert a moderation action log entry.
Response after inserting a moderation action log
This event is sent when a buffered conversation's intent score clears the configured
threshold
An interest tag of a user with its ranking weight and, for computed tags, how many distinct
reacted-to activities carried it
This 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 labels
Basic response information
List block lists Returns all available block lists
Response for ListCallType
List Call Type
List channel types Lists all available channel types
List commands Returns all custom commands
List devices Returns all available devices
List devices response
List external storage Lists external storage
Basic response information
List all feed groups List all feed groups for the application
Basic response information
List all feed views List persisted feed views for the application.
List feed visibilities Gets all available feed visibility configurations and their permissions
Get import Gets an import
Basic response information
List import v2 tasks Lists all import v2 tasks for the app
Basic response information
List permissions Lists all available permissions
Basic response information
List policy test sets
List push providers List details of all push providers.
Basic response information
List queues
Basic response information
List recordings Lists recordings
Response for listing recordings
List roles Lists all available roles
Basic response information
List SIP Inbound Routing Rules List all SIP Inbound Routing Rules for the application
Response containing the list of SIP Inbound Routing Rules
List SIP Trunks List all SIP trunks for the application
Response containing the list of SIP trunks
List transcriptions Lists transcriptions
List user groups Lists user groups with cursor-based pagination
Response for listing user groups
Geographic location metadata
Mark 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 information
Mark read Marks channel as read up to the specific message Sends events: - message.read
Configuration for mark reviewed action
Mark unread Marks channel as unread from a specific message
Emitted 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 information
Emitted when a message is deleted.
This event is sent when a message gets flagged.
Result of the message moderation
Emitted 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 message
Represents any chat message
Emitted 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 message
Statistics for a single metric with optional daily breakdown
Configuration for a moderation action
An /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 completed
This event is sent when a custom moderation action is executed
This event is sent when content is flagged for moderation
Per-image moderation verdict from /analyze.
This event is sent when a moderation item is marked as reviewed
Content payload for moderation
Content payload for moderation
This event is sent automatically whenever a rule builder rule is triggered
Per-text moderation verdict from /analyze.
Mute channel Mutes channel for user Sends events: - channel.muted
Mute Mute a user.
Mute users Mutes users in a call
MuteUsersResponse is the response payload for the mute users endpoint.
Deserializer for timestamps that are represented as Unix nanoseconds.
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 use
Pending message event for async moderation
This 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 user
Pin an activity to a feed Pin an activity to a feed.
PinRequest is the payload for pinning a message.
Basic response information
Policy request
Query activities Query activities based on filters with pagination and sorting options
Query activity reactions Query activity reactions
Basic response information
Query activity shares List the shares recorded for an activity, newest-first
Basic response information
Query Aggregate call Stats
Basic response information
Query Appeals Query Appeals
Query Banned Users Find and filter channel scoped or global user bans
Query bookmark folders Query bookmark folders with filter query
Query bookmarks Query bookmarks with filter query
Query call members Query call members with filter query
Basic response information
Query call participant sessions
Basic response information
Query call participants Returns a list of participants connected to the call
Query call participant statistics
Basic response information
Basic response information
Query call session stats
Basic response information
Query call Query calls with filter query
Basic response information
Query Call Stats
Basic response information
Query campaigns Query campaigns with filter query
Basic response information
Query channels Query channels with filter query
Query collections Query collections with filter query
Query comment reactions Query comment reactions
Basic response information
Query comments Query comments using MongoDB-style filters with pagination and sorting options
Query draft messages Queries draft messages for a user
Query feed members Query feed members based on filters with pagination and sorting options
Query feeds Query feeds with filter query
Query 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 options
Query Future Channel Bans Find and filter future channel bans created by the authenticated user
Query label results Search and filter moderation label results with support for pagination and
sorting.
Query membership levels Query membership levels with filter query
Query members Find and filter channel members
Query Message Flags Find and filter message flags
Query message flags response
Query message history Queries history for one message
Query moderation configurations Search and filter moderation configurations across your
application.
Query moderation flags Query flags associated with moderation items.
Basic response information
Query 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 query
Query polls Queries polls
Query votes Queries votes
Get reactions on a message
Basic response information
Query reminders Queries reminders
Query review queue items Query review queue items allows you to filter the review queue items.
Query revision history Queries revision history for activities and comments
Query segments Query segments
Query segment targets Query segment targets
Query Team Usage Statistics Retrieve team-level usage statistics from the warehouse database.
Response containing team-level usage statistics
Query Threads Returns the list of threads for specific user
Query user reported feedback for the calls
Basic response information
Query users Find and filter users
Basic response information
Emitted 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 message
Emitted when a reaction is updated on a message.
Reactivate user Activates user who's been deactivated previously Sends events: -
user.reactivated
Reactivate users Reactivate users in batches Sends events: - user.reactivated
Basic response information
Read collections Read collections by their references.
RecordSettings is the payload for recording settings
Configuration for rejecting an appeal
Reject an invite to become a feed member Rejects a pending feed member request
Reject a follow request Rejects a pending follow request
Emitted 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 group
Cursor & 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 events
Resolve SIP Auth Determine authentication requirements for an inbound SIP call before sending a
digest challenge
Response containing the pre-authentication decision for a SIP trunk
Resolve SIP Inbound Routing Resolve SIP inbound routing based on trunk number, caller number, and
challenge authentication
Response containing resolved SIP inbound routing information
Basic response information
Configuration 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 users
Opt-in auto-retry policy.
This event is sent when a new moderation review queue item is created
This event is sent when a moderation review queue item is updated
Ring 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 settings
RTMPSettingsResponse is the payload for RTMP settings
Run message command action Executes message command action with given parameters Sends events: -
message.new
Config for creating Amazon S3 storage.
Search messages Search messages across channels
Search roles Searches mentionable roles (user-assignable + channel-assignable, built-in and
custom) by name prefix for autocomplete
Search user groups Searches user groups by name prefix for autocomplete
Response for searching user groups
Check 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: - custom
Send closed caption Sends a closed caption event to the call Sends events: - call.closed_caption
Send event Sends event to the channel
Send new message Sends new message to the specified channel Sends events: - channel.visible -
message.new - message.updated
Send reaction Sends reaction to specified message Sends events: - reaction.new - reaction.updated
Basic response information
Send user event Sends a custom event to a user Sends events: - *
Basic response information
Set retention policy Creates or updates a retention policy for the app.
Basic response information
Configuration for shadow block action
Show channel Shows previously hidden channel Sends events: - channel.visible
Basic response information
Configuration for SIP call settings
SIP call configuration response
Configuration for SIP caller settings
SIP caller configuration response
SIP digest challenge authentication data
Configuration for direct routing rule calls
Direct routing rule call configuration response
Credentials for SIP inbound call authentication
Configuration for PIN routing rule calls
PIN routing rule call configuration response
Request to create or update a SIP Inbound Routing Rule
SIP Inbound Routing Rule response
Configuration for PIN protection settings
PIN protection configuration response
SIP trunk information
Start/schedule campaign Starts or schedules a campaign
Basic response information
Start closed captions Starts closed captions
Start frame recording Starts frame by frame recording Sends events: -
call.frame_recording_started
StartFrameRecordingResponse is the response payload for the start frame recording endpoint.
Start HLS broadcasting Starts HLS broadcasting
StartHLSBroadcastingResponse 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_started
StartRecordingResponse is the response payload for the start recording endpoint.
Start RTMP broadcasts Starts RTMP broadcasts for the provided RTMP destinations
StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.
Start transcription Starts transcription
Stop all RTMP broadcasts for a call Stop all RTMP broadcasts for the provided call
Stop campaign Stops a campaign
Stop closed captions Stops closed captions Sends events: - call.transcription_stopped
Basic response information
Stop frame recording Stops frame recording Sends events: - call.frame_recording_stopped
Basic response information
Stop HLS broadcasting Stops HLS broadcasting
Basic response information
Set call as not live Sends events: - call.updated
Stop recording Stops recording Sends events: - call.recording_stopped
Basic response information
Stop RTMP broadcasts Stop RTMP broadcasts for the provided RTMP destinations
Request for stopping RTMP broadcasts
Basic response information
Stop transcription Stops transcription Sends events: - call.transcription_stopped
Basic response information
Emitted when stories feed is updated.
Thrown when the Stream API returns a 4xx/5xx response.
Tunables for the SDK's HTTP transport / connection pool.
Thrown when the Stream API returns HTTP 429.
Thrown when an async task observed via
waitForTask reaches status: "failed".Thrown when a network-layer failure prevents the SDK from receiving an HTTP response.
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 metrics
A comment with an optional, depth‑limited slice of nested replies.
Represents a user that is participating in a thread.
Sets thresholds for AI moderation
A single metric event to track for an activity
Result of tracking a single metric event
Track activity metrics Track metric events (views, clicks, impressions) for activities.
Response containing results for each tracked metric event
Translate activity Translates an activity's text to a given language using automated
translation Sends events: - feeds.activity.updated
Basic response information
Translate comment Translates a comment's text to a given language using automated translation
Sends events: - feeds.comment.updated
Basic response information
Translate message Translates message to a given language using automated translation software
Sends events: - message.updated
Basic response information
Truncate channel Truncates messages from a channel.
Configuration for unban moderation action
Unban 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 again
Unblocks user on a call Removes the block for a user on a call.
UnblockUserResponse is the payload for unblocking a user.
Unblock user Unblock users
Undelete message Undelete a message that was previously soft-deleted Sends events: -
message.undeleted
Basic response information
Unfollow multiple feeds at once Removes multiple follows at once and broadcasts
FollowRemovedEvent for each one
Unfollow a feed Removes a follow and broadcasts FollowRemovedEvent
Unmute channel Unmutes channel for user Sends events: - channel.unmuted
Unmute a user Unmute a user
Unpin 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 call
Basic response information
Unread counts Fetch unread counts for a single user
Batch 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 settings
Update block list Updates contents of the block list
Basic response information
Update a bookmark folder Update a bookmark folder by its ID
Update bookmark Updates a bookmark for an activity
Update Call Member Sends events: - call.member_added - call.member_removed - call.member_updated
Basic response information
Update Call Sends events: - call.updated
Response for updating a call
Update Call Type
UpdateCallTypeResponse is the payload for updating a call type.
Update campaign Updates a campaign
Partially update channel Updates certain fields of the channel Sends events: - channel.updated
Update channel Change channel data Sends events: - channel.updated - member.added -
member.removed - member.updated - message.new
Update channel type Updates channel type
Basic response information
Update multiple collections Update existing collections in a batch operation.
Update command Updates custom chat command
Update comment bookmark Updates a bookmark for a comment
Partial comment update Updates certain fields of the comment.
Update a comment Updates a comment on an object (e.g., activity) and broadcasts appropriate
events
This event is sent to notify about permission changes for a user, clients receiving this event
should update their UI accordingly
Update External Storage
Basic response information
Update a feed group Update a feed group by ID
Update feed members Add, remove, or set members for a feed
Basic response information
Update a feed Update an existing feed
Update a feed view Update an existing custom feed view with new selectors, ranking, or
aggregation options
Update Feed Visibility Updates an existing predefined feed visibility configuration
Update 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 time
Partially channel member update
Update membership level Update a membership level with partial updates.
Partially message update Updates certain fields of the message Sends events: - message.updated
Update message Updates message with new data Sends events: - message.updated
Basic response information
Update permission Updates custom permission
Update poll option Updates a poll option Sends events: - feeds.poll.updated - poll.updated
Partial update poll Updates a poll partially Sends events: - feeds.poll.closed -
feeds.poll.updated - poll.closed - poll.updated
Update poll Updates a poll Sends events: - feeds.poll.closed - feeds.poll.updated - poll.closed -
poll.updated
Update predefined filter Update a predefined filter by name
Push notification preferences Upserts the push preferences for a user and or channel member.
Update queue
Updates Reminder Updates an existing reminder.
Basic response information
Update segment Update an existing segment
Update SIP Inbound Routing Rule Update an existing SIP Inbound Routing Rule with new
configuration
Response containing the updated SIP Inbound Routing Rule
Update SIP Trunk Update a SIP trunk for the application
Response containing the updated SIP trunk
Partially update thread Updates certain fields of the thread Sends events: - thread.updated
Update user group Updates a user group's name and/or description.
Response for updating a user group
Update user permissions Updates user permissions Sends events: - call.permissions_updated
Basic response information
Partially update user Updates certain fields of the user Sends events: - user.presence.changed -
user.updated
Upsert users Update or create users in bulk Sends events: - user.updated
Upload file Uploads file
Upload image Uploads image
Upload file Uploads file
Upload image Uploads image
Create 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 operation
Upsert 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 information
Upsert 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 configs
Basic response information
Upsert a push provider Upsert a push provider for v2 with multi bundle/package support
Basic response information
Upsert a push notification template Create or update a push notification template for a specific
event type and push provider
Basic response information
Create or update moderation setup session Update a setup session for an app
Set 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 name
This 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 weight
This 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 object
User response object
This 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 name
Query feed moderation templates Retrieve a list of feed moderation templates that define preset
moderation rules and configurations.
Upsert feeds template Upsert feeds template for moderation
Basic response information
Validate external storage Validates the configured external storage.
Configuration for ending video call
Configuration for kicking user from video call
Pin Pins a track for all users in the call.
Unpin Unpins a track for all users in the call.
Webhook utilities for Stream webhooks.
Webhook event type constants.
Thrown for every webhook handling failure: signature mismatch, invalid JSON, missing/non-string
type field, gzip-prefixed body that fails to decompress, invalid base64 in a queue
body, or a malformed SNS envelope.Returned by
Webhook.parseEvent(byte[]) when the type discriminator is well-formed but unknown
to this SDK version.Deprecated.
Renamed to
Webhook.InvalidWebhookError.The discriminator object for all webhook events, it maps events' payload to the final type
Basic response information
Represents an BaseEvent that happened in Stream Chat
StreamClientOptions.setLogger).