Skip to content

Signal.Bot.Types Namespace

Types

About

Represents information about the Signal Bot API server including version, build, and capabilities.

Acknowledged

Represents an acknowledgment response from the Signal Bot API, indicating that an operation was successfully received and processed.

Attachment

Represents a file attachment in a Signal message.

Configuration

Represents the configuration settings for the Signal Bot API.

Contact

Represents a Signal contact with profile information and settings.

DataMessage

Represents the main content of a Signal message, including text, attachments, reactions, and metadata.

Device

Represents a linked device associated with a Signal account.

Envelope

Represents the envelope container for a received Signal message, containing metadata and message content.

ErrorResponse

Represents an error response from the Signal Bot API.

Group

Represents a Signal group with its members, settings, and metadata.

GroupV2Info

Represents information about a Signal v2 group in a message context.

Identity

Represents a Signal identity with cryptographic fingerprint and trust status information for end-to-end encryption verification.

IdentityStatus

Defines the trust status of a Signal identity (safety number) for end-to-end encryption verification. Values: Undefined (unknown status), Untrusted (not verified), TrustedUnverified (trusted but not manually verified), TrustedVerified (manually verified through safety number comparison).

LoggingConfiguration

Represents the logging configuration settings for the Signal Bot API.

Mention

Represents a mention of a user within a message, specifying their position in the text.

Nickname

Represents the nickname components for a contact, including given name and family name.

PreviewData

Represents a link preview with metadata and thumbnail for a URL mentioned in a message.

Profile

Represents a Signal user's profile information including name, about text, and avatar status.

ProfileCapabilities

Represents the feature capabilities supported by a Signal user's client.

QuoteData

Represents a quoted (replied-to) message within a Signal message.

Represents the raw device linking URI used for provisioning a new device without a QR code.

ReactionData

Represents an emoji reaction to a message, including the target message information.

ReadMessage

Represents a read receipt for a message, indicating that a specific user has read the message.

ReceiptMessage

Represents a message containing read or delivery receipts for one or more messages.

ReceivedMessageEnvelope

Represents a received message envelope container with the message content and account information.

Represents the registration status result for a searched phone number.

SetUsername

Represents the result of setting a username, including the username and its shareable link.

StickerPack

Represents a Signal sticker pack with its metadata and installation status.

SyncMessage

Represents a synchronization message sent between linked devices, containing read receipt information.

TypingMessage

Represents a typing indicator message showing that a user is composing a message.