Stream Chat API

Tools (118)

Extracted live via the executor SDK.

• calls.getCallToken1

  Retrieves the token to join a call

• calls.getCallTokenCallId0

  Retrieves the token to join a call

• campaigns.createCampaign

  Creates a new campaign

• campaigns.createSegment

  Create a segment

• campaigns.deleteCampaign

  Delete a campaign

• campaigns.deleteSegment

  Delete a segment

• campaigns.queryCampaigns

  Query campaigns

• campaigns.queryRecipients

  Query recipients

• campaigns.querySegments

  Query segments

• campaigns.resumeCampaign

  Resume a stopped campaign

• campaigns.scheduleCampaign

  Schedule a campaign

• campaigns.stopCampaign

  Stop a running campaign

• campaigns.testCampaign

  Test a campaign

• campaigns.updateCampaign

  Update an existing campaign

• campaigns.updateSegment

  Update an existing segment

• channels.createCall

  Creates a call

• channels.deleteChannel

  Deletes channel

• channels.deleteChannels

  Allows to delete several channels at once asynchronously

• channels.exportChannels

  Exports channel data to JSON file

• channels.getExportChannelsStatus

  Export channels status

• channels.getOrCreateChannelType1

  This method creates a channel or returns an existing one with matching attributes

• channels.getOrCreateChannelTypeId0

  This method creates a channel or returns an existing one with matching attributes

• channels.hideChannel

  Marks channel as hidden for current user

• channels.markChannelsRead

  Marks channels as read up to the specific message. If no channels is given, mark all channel as read

• channels.markRead

  Marks channel as read up to the specific message

• channels.markUnread

  Marks channel as unread from a specific message

• channels.muteChannel

  Mutes channel for user

• channels.queryChannels

  Query channels with filter query

• channels.queryMembers

  Find and filter channel members

• channels.search

  Search messages across channels

• channels.showChannel

  Shows previously hidden channel

• channels.stopWatchingChannel

  Call this method to stop receiving channel events

• channels.sync

  Returns all events happened since client disconnect in specified channels

• channels.truncateChannel

  Truncates channel

• channels.unmuteChannel

  Unmutes channel for user

• channels.updateChannel

  Change channel data

• channels.updateChannelPartial

  Updates certain fields of the channel

• customCommands.createCommand

  Creates custom chat command

• customCommands.deleteCommand

  Deletes custom chat command

• customCommands.getCommand

  Returns custom command by its name

• customCommands.listCommands

  Returns all custom commands

• customCommands.updateCommand

  Updates custom chat command

• devices.createDevice

  Adds a new device to a user, if the same device already exists the call will have no effect

• devices.deleteDevice

  Deletes device

• devices.listDevices

  Returns all available devices

• events.sendEvent

  Sends event to the channel

• events.sendUserCustomEvent

  Sends a custom event to a user

• imports.createImport

  Creates a new import

• imports.createImportUrl

  Creates a new import URL

• imports.getImport

  Gets an import

• imports.listImports

  Gets an import

• messages.commitMessage

  Commits a pending message, which will make it visible in the channel

• messages.deleteFile

  Deletes previously uploaded file

• messages.deleteImage

  Deletes previously uploaded image

• messages.deleteMessage

  Deletes message

• messages.deleteReaction

  Removes user reaction from the message

• messages.getManyMessages

  Returns list messages found by IDs

• messages.getMessage

  Returns message by ID

• messages.getOg

  Get an OpenGraph attachment for a link

• messages.getReactions

  Returns list of reactions of specific message

• messages.getReplies

  Returns replies (thread) of the message

• messages.queryMessageFlags

  Find and filter message flags

• messages.runMessageAction

  Executes message command action with given parameters

• messages.sendMessage

  Sends new message to the specified channel

• messages.sendReaction

  Sends reaction to specified message

• messages.translateMessage

  Translates message to a given language using automated translation software

• messages.updateMessage

  Updates message with new data

• messages.updateMessagePartial

  Updates certain fields of the message

• messages.uploadFile

  Uploads file

• messages.uploadImage

  Uploads image

• moderation.flag

  Reports message or user for review by moderators

• moderation.unflag

  Removes previously created user or message flag

• permissionsV2.createRole

  Creates custom role

• permissionsV2.deleteRole

  Deletes custom role

• permissionsV2.getPermission

  Gets custom permission

• permissionsV2.listPermissions

  Lists all available permissions

• permissionsV2.listRoles

  Lists all available roles

• push.deletePushProvider

  Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint

• push.listPushProviders

  List details of all push providers.

• push.upsertPushProvider

  Upsert a push provider for v2 with multi bundle/package support

• settings.checkPush

  Sends a test message via push, this is a test endpoint to verify your push settings

• settings.checkSqs

  Validates Amazon SQS credentials

• settings.createBlockList

  Creates a new application blocklist, once created the blocklist can be used by any channel type

• settings.createChannelType

  Creates new channel type

• settings.deleteBlockList

  Deletes previously created application blocklist

• settings.deleteChannelType

  Deletes channel type

• settings.getApp

  This method returns the application settings

• settings.getBlockList

  Returns block list by given name

• settings.getChannelType

  Gets channel type

• settings.getRateLimits

  Get rate limits usage and quotas

• settings.listBlockLists

  Returns all available block lists

• settings.listChannelTypes

  Lists all available channel types

• settings.updateApp

  This method updates one or more application settings

• settings.updateBlockList

  Updates contents of the block list

• settings.updateChannelType

  Updates channel type

• tasks.getTask

  Gets status of a task

• users.ban

  Restricts user activity either in specific channel or globally

• users.connect

  Establishes WebSocket connection for user

• users.createGuest

  Creates guest user

• users.deactivateUser

  Deactivates user with possibility to activate it back

• users.deactivateUsers

  Deactivate users in batches

• users.deleteUser

  Deletes user and optionally all their belongings. The Endpoint is deprecated, please use 'Delete Users' endpoint instead

• users.deleteUsers

  Deletes users and optionally all their belongings asynchronously.

• users.exportUser

  Exports user profile, reactions and messages for list of given users

• users.getUsersUserIdExport

  Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions

• users.longPoll

  WebSocket fallback transport endpoint

• users.muteUser

  Mutes one or several users

• users.queryBannedUsers

  Find and filter channel scoped or global user bans

• users.queryUsers

  Find and filter users

• users.reactivateUser

  Activates user who's been deactivated previously

• users.reactivateUsers

  Reactivate users in batches

• users.restoreUsers

  Restore soft deleted users

• users.unban

  Removes previously applied ban

• users.unmuteUser

  Unmutes previously muted user

• users.updateUsers

  Update or create users in bulk

• users.updateUsersPartial

  Updates certain fields of the user

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools