data class GroupConvo(val createdAt: Timestamp, val joinLink: JoinLinkView? = null, val joinRequestCount: Long? = null, val lockStatus: ConvoLockStatus, val lockStatusModerationOverride: Boolean, val memberCount: Long, val memberLimit: Long, val name: String, val unreadJoinRequestCount: Long? = null)

NOTE: This is under active development and should be considered unstable while this note is here.

LeaveConvoRequest

@Serializable

data class LeaveConvoRequest(val convoId: String)

LeaveConvoResponse

@Serializable

data class LeaveConvoResponse(val convoId: String, val rev: String)

ListConvoRequestsQueryParams

@Serializable

data class ListConvoRequestsQueryParams(val limit: Long? = 50, val cursor: String? = null)

ListConvoRequestsResponse

@Serializable

data class ListConvoRequestsResponse(val cursor: String? = null, val requests: List<ListConvoRequestsResponseRequestUnion>)

ListConvoRequestsResponseRequestUnion

@Serializable

sealed interface ListConvoRequestsResponseRequestUnion

ListConvosKind

@Serializable(with = ListConvosKindSerializer::class)

sealed class ListConvosKind : AtpEnum

Filter by conversation kind.

ListConvosKindSerializer

class ListConvosKindSerializer : KSerializer<ListConvosKind>

ListConvosLockStatus

@Serializable(with = ListConvosLockStatusSerializer::class)

sealed class ListConvosLockStatus : AtpEnum

Filter by conversation lock status. Values follow chat.bsky.convo.defs#convoLockStatus.

ListConvosLockStatusSerializer

class ListConvosLockStatusSerializer : KSerializer<ListConvosLockStatus>

ListConvosQueryParams

@Serializable

data class ListConvosQueryParams(val limit: Long? = 50, val cursor: String? = null, val readState: ListConvosReadState? = null, val status: ListConvosStatus? = null, val kind: ListConvosKind? = null, val lockStatus: ListConvosLockStatus? = null)

ListConvosReadState

@Serializable(with = ListConvosReadStateSerializer::class)

sealed class ListConvosReadState : AtpEnum

ListConvosReadStateSerializer

class ListConvosReadStateSerializer : KSerializer<ListConvosReadState>

ListConvosResponse

@Serializable

data class ListConvosResponse(val cursor: String? = null, val convos: List<ConvoView>)

ListConvosStatus

@Serializable(with = ListConvosStatusSerializer::class)

sealed class ListConvosStatus : AtpEnum

Filter convos by their status. It is discouraged to call with "request" and preferred to call chat.bsky.convo.listConvoRequests, which also includes group join requests made by the user.

ListConvosStatusSerializer

class ListConvosStatusSerializer : KSerializer<ListConvosStatus>

LockConvoRequest

@Serializable

data class LockConvoRequest(val convoId: String)

LockConvoResponse

@Serializable

data class LockConvoResponse(val convo: ConvoView)

LogAcceptConvo

@Serializable

data class LogAcceptConvo(val rev: String, val convoId: String)

Event indicating the viewer accepted a convo, and it can be moved out of the request inbox. Can be direct or group.

LogAddMember

@Serializable

data class LogAddMember(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member was added to a group convo. The member who was added gets a logBeginConvo (to create the convo) but also a logAddMember (to show the system message as the first message the user sees).

LogAddReaction

@Serializable

data class LogAddReaction(val rev: String, val convoId: String, val message: LogAddReactionMessageUnion, val reaction: ReactionView, val relatedProfiles: List<ProfileViewBasic>? = null)

Event indicating a reaction was added to a message.

LogAddReactionMessageUnion

@Serializable

sealed interface LogAddReactionMessageUnion

LogApproveJoinRequest

@Serializable

data class LogApproveJoinRequest(val rev: String, val convoId: String, val member: ProfileViewBasic)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was approved by the viewer. Only the owner gets this. The approved member gets a logBeginConvo.

LogBeginConvo

@Serializable

data class LogBeginConvo(val rev: String, val convoId: String)

Event indicating a convo containing the viewer was started. Can be direct or group. When a member is added to a group convo, they also get this event.

LogCreateJoinLink

@Serializable

data class LogCreateJoinLink(val rev: String, val convoId: String, val message: SystemMessageView)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was created for a group convo.

LogCreateMessage

@Serializable

data class LogCreateMessage(val rev: String, val convoId: String, val message: LogCreateMessageMessageUnion, val relatedProfiles: List<ProfileViewBasic>? = null)

Event indicating a user-originated message was created. Is not emitted for system messages.

LogCreateMessageMessageUnion

@Serializable

sealed interface LogCreateMessageMessageUnion

LogDeleteMessage

@Serializable

data class LogDeleteMessage(val rev: String, val convoId: String, val message: LogDeleteMessageMessageUnion)

Event indicating a user-originated message was deleted. Is not emitted for system messages.

LogDeleteMessageMessageUnion

@Serializable

sealed interface LogDeleteMessageMessageUnion

LogDisableJoinLink

@Serializable

data class LogDisableJoinLink(val rev: String, val convoId: String, val message: SystemMessageView)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was disabled for a group convo.

LogEditGroup

@Serializable

data class LogEditGroup(val rev: String, val convoId: String, val message: SystemMessageView)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating info about group convo was edited.

LogEditJoinLink

@Serializable

data class LogEditJoinLink(val rev: String, val convoId: String, val message: SystemMessageView)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a settings about a join link for a group convo were edited.

LogEnableJoinLink

@Serializable

data class LogEnableJoinLink(val rev: String, val convoId: String, val message: SystemMessageView)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was enabled for a group convo.

LogIncomingJoinRequest

@Serializable

data class LogIncomingJoinRequest(val rev: String, val convoId: String, val member: ProfileViewBasic)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was made to a group the viewer owns. Only the owner gets this.

LogLeaveConvo

@Serializable

data class LogLeaveConvo(val rev: String, val convoId: String)

Event indicating the viewer left a convo. Can be direct or group.

LogLockConvo

@Serializable

data class LogLockConvo(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was locked.

LogLockConvoPermanently

@Serializable

data class LogLockConvoPermanently(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was locked permanently.

LogMemberJoin

@Serializable

data class LogMemberJoin(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member joined a group convo via join link. The member who was added gets a logBeginConvo (to create the convo) but also a logMemberJoin (to show the system message as the first message the user sees).

LogMemberLeave

@Serializable

data class LogMemberLeave(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member voluntarily left a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logMemberLeave (because they already left, so can't see the system message).

LogMuteConvo

@Serializable

data class LogMuteConvo(val rev: String, val convoId: String)

Event indicating the viewer muted a convo. Can be direct or group.

LogOutgoingJoinRequest

@Serializable

data class LogOutgoingJoinRequest(val rev: String, val convoId: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was made by the requester. Only requester actor gets this.

LogReadConvo

@Serializable

data class LogReadConvo(val rev: String, val convoId: String, val message: LogReadConvoMessageUnion)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a convo was read up to a certain message.

LogReadConvoMessageUnion

@Serializable

sealed interface LogReadConvoMessageUnion

LogReadJoinRequests

@Serializable

data class LogReadJoinRequests(val rev: String, val convoId: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating the group owner marked join requests as read. Only the owner gets this.

LogReadMessage

@Serializable

data class ~~LogReadMessage~~(val rev: String, val convoId: String, val message: LogReadMessageMessageUnion)

LogReadMessageMessageUnion

@Serializable

sealed interface LogReadMessageMessageUnion

LogRejectJoinRequest

@Serializable

data class LogRejectJoinRequest(val rev: String, val convoId: String, val member: ProfileViewBasic)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was rejected by the viewer. Only the owner gets this.

LogRemoveMember

@Serializable

data class LogRemoveMember(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member was removed from a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logRemoveMember (because they already left, so can't see the system message).

LogRemoveReaction

@Serializable

data class LogRemoveReaction(val rev: String, val convoId: String, val message: LogRemoveReactionMessageUnion, val reaction: ReactionView, val relatedProfiles: List<ProfileViewBasic>? = null)

Event indicating a reaction was removed from a message.

LogRemoveReactionMessageUnion

@Serializable

sealed interface LogRemoveReactionMessageUnion

LogUnlockConvo

@Serializable

data class LogUnlockConvo(val rev: String, val convoId: String, val message: SystemMessageView, val relatedProfiles: List<ProfileViewBasic>)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was unlocked.

LogUnmuteConvo

@Serializable

data class LogUnmuteConvo(val rev: String, val convoId: String)

Event indicating the viewer unmuted a convo. Can be direct or group.

LogWithdrawIncomingJoinRequest

@Serializable

data class LogWithdrawIncomingJoinRequest(val rev: String, val convoId: String, val member: ProfileViewBasic)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a prospective member withdrew their join request. Only the owner gets this.

LogWithdrawOutgoingJoinRequest

@Serializable

data class LogWithdrawOutgoingJoinRequest(val rev: String, val convoId: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating the viewer withdrew their own join request. Only requester actor gets this.

MessageAndReactionView

@Serializable

data class MessageAndReactionView(val message: MessageView, val reaction: ReactionView)

MessageInput

@Serializable

data class MessageInput(val text: String, val facets: List<Facet>? = null, val embed: MessageInputEmbedUnion? = null)

MessageInputEmbedUnion

@Serializable

sealed interface MessageInputEmbedUnion

MessageRef

@Serializable

data class MessageRef(val did: Did, val convoId: String, val messageId: String)

MessageView

@Serializable

data class MessageView(val id: String, val rev: String, val text: String, val facets: List<Facet>? = null, val embed: MessageViewEmbedUnion? = null, val reactions: List<ReactionView>? = null, val sender: MessageViewSender, val sentAt: Timestamp)

MessageViewEmbedUnion

@Serializable

sealed interface MessageViewEmbedUnion

MessageViewSender

@Serializable

data class MessageViewSender(val did: Did)

MuteConvoRequest

@Serializable

data class MuteConvoRequest(val convoId: String)

MuteConvoResponse

@Serializable

data class MuteConvoResponse(val convo: ConvoView)

ReactionView

@Serializable

data class ReactionView(val value: String, val sender: ReactionViewSender, val createdAt: Timestamp)

ReactionViewSender

@Serializable

data class ReactionViewSender(val did: Did)

RemoveReactionRequest

@Serializable

data class RemoveReactionRequest(val convoId: String, val messageId: String, val value: String)

RemoveReactionResponse

@Serializable

data class RemoveReactionResponse(val message: MessageView)

SendMessageBatchBatchItem

@Serializable

data class SendMessageBatchBatchItem(val convoId: String, val message: MessageInput)

SendMessageBatchRequest

@Serializable

data class SendMessageBatchRequest(val items: List<SendMessageBatchBatchItem>)

SendMessageBatchResponse

@Serializable

data class SendMessageBatchResponse(val items: List<MessageView>)

SendMessageRequest

@Serializable

data class SendMessageRequest(val convoId: String, val message: MessageInput)

SendMessageResponse

typealias SendMessageResponse = MessageView

SystemMessageDataAddMember

@Serializable

data class SystemMessageDataAddMember(val member: SystemMessageReferredUser, val role: MemberRole, val addedBy: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user was added to the group convo.

SystemMessageDataCreateJoinLink

@Serializable

object SystemMessageDataCreateJoinLink

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was created.

SystemMessageDataDisableJoinLink

@Serializable

object SystemMessageDataDisableJoinLink

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was disabled.

SystemMessageDataEditGroup

@Serializable

data class SystemMessageDataEditGroup(val oldName: String? = null, val newName: String? = null)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group info was edited.

SystemMessageDataEditJoinLink

@Serializable

object SystemMessageDataEditJoinLink

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was edited.

SystemMessageDataEnableJoinLink

@Serializable

object SystemMessageDataEnableJoinLink

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was enabled.

SystemMessageDataLockConvo

@Serializable

data class SystemMessageDataLockConvo(val lockedBy: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was locked.

SystemMessageDataLockConvoPermanently

@Serializable

data class SystemMessageDataLockConvoPermanently(val lockedBy: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was locked permanently.

SystemMessageDataMemberJoin

@Serializable

data class SystemMessageDataMemberJoin(val member: SystemMessageReferredUser, val role: MemberRole, val approvedBy: SystemMessageReferredUser? = null)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user joined the group convo via join link.

SystemMessageDataMemberLeave

@Serializable

data class SystemMessageDataMemberLeave(val member: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user voluntarily left the group convo.

SystemMessageDataRemoveMember

@Serializable

data class SystemMessageDataRemoveMember(val member: SystemMessageReferredUser, val removedBy: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user was removed from the group convo.

SystemMessageDataUnlockConvo

@Serializable

data class SystemMessageDataUnlockConvo(val unlockedBy: SystemMessageReferredUser)

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was unlocked.

SystemMessageReferredUser

@Serializable

data class SystemMessageReferredUser(val did: Did)

SystemMessageView

@Serializable