Signal.Bot

Appearance

Signal.Bot.Requests Namespace ​

Types ​

AddDeviceRequest ​

Represents a request to add a new device to a Signal account.

AddGroupAdminRequest ​

Represents a request to add administrators to a Signal group.

AddGroupMemberRequest ​

Represents a request to add members to a Signal group.

AddReactionRequest ​

Represents a request to add an emoji reaction to a specific message.

AddStickerPackRequest ​

Represents a request to install a sticker pack to the Signal account.

AddTypingIndicatorRequest ​

Represents a request to display a typing indicator to show that the bot is composing a message.

BlockGroupRequest ​

Represents a request to block all messages from a specific Signal group.

CreateGroupRequest ​

Represents a request to create a new Signal group with specified settings and initial members.

Permissions ​

Defines permission settings for various group actions, controlling which members can perform specific operations.

GroupPermission ​

Defines the permission levels for group actions.

Defines the access levels for group invitation links.

GetAboutRequest ​

Represents a request to retrieve general information about the Signal Bot API service.

GetAccountsRequest ​

Represents a request to retrieve all registered Signal accounts managed by this bot instance.

GetAttachmentRequest ​

Represents a request to download a specific attachment by its unique identifier.

GetAttachmentsRequest ​

Represents a request to retrieve a list of all attachment IDs stored by the bot.

GetConfigurationRequest ​

Represents a request to retrieve the current configuration settings of the Signal Bot API.

GetContactRequest ​

Represents a request to retrieve detailed information about a specific contact.

GetContactsRequest ​

Represents a request to retrieve all contacts stored in the Signal account.

GetDevicesRequest ​

Represents a request to retrieve all linked devices associated with a Signal account.

GetGroupRequest ​

Represents a request to retrieve detailed information about a specific Signal group.

GetGroupsRequest ​

Represents a request to retrieve all Signal groups that the account is a member of.

GetIdentitiesRequest ​

Represents a request to retrieve all known identity keys for contacts, used for verifying end-to-end encryption.

GetQrCodeLinkRequest ​

Represents a request to generate a QR code link for linking a new device to the Signal account.

GetRawDeviceLinkRequest ​

Represents a request to retrieve raw device linking information for provisioning a new device without a QR code.

GetReceivedMessagesRequest ​

Represents a request to receive incoming Signal messages from the queue.

GetStickerPacksRequest ​

Represents a request to retrieve all sticker packs installed or available to the Signal account.

IRequest ​

Defines the base contract for all Signal Bot API requests without a typed response.

JoinGroupRequest ​

Represents a request to join an existing Signal group using a group link or invitation.

QuitGroupRequest ​

Represents a request to leave a Signal group, removing the account from the member list.

RateLimitChallengeRequest ​

Represents a request to complete a rate limit challenge when Signal requires additional verification due to excessive API usage.

RegisterNumberRequest ​

Represents a request to initiate the registration process for a phone number with Signal.

RemoteDeleteRequest ​

Represents a request to remotely delete a message from a conversation for all participants.

RemoveAttachmentRequest ​

Represents a request to delete a specific attachment from the bot's storage.

RemoveGroupAdminRequest ​

Represents a request to remove administrator privileges from one or more group members.

RemoveGroupMemberRequest ​

Represents a request to remove one or more members from a Signal group.

RemoveGroupRequest ​

Represents a request to delete a Signal group. Only group administrators can perform this action.

RemovePinRequest ​

Represents a request to remove the registration lock PIN from the Signal account.

RemoveReactionRequest ​

Represents a request to remove an emoji reaction from a specific message.

RemoveTypingIndicatorRequest ​

Represents a request to stop displaying the typing indicator, signaling that message composition has stopped.

RemoveUsernameRequest ​

Represents a request to remove the username from the Signal account, reverting to phone number-only identification.

RequestBase ​

Base class for all Signal Bot API requests without a typed response. Provides common functionality for HTTP method specification and JSON serialization.

SearchNumbersRequest ​

Represents a request to search for Signal users by their phone numbers to check registration status.

SendMessageRequest ​

Represents a request to send a message via the Signal Bot API.

MessageMention ​

Represents a mention of a user within a message, specifying the author and the text position.

LinkPreview ​

Represents a link preview configuration for URLs in a message, including title, description, and thumbnail.

TextMode ​

Defines the text formatting modes available for Signal messages.

SendReceiptsRequest ​

Represents a request to send a read receipt, delivery receipt, or viewed receipt for a message.

ReceiptType ​

Defines the types of message receipts that can be sent in Signal.

SetConfigurationRequest ​

Represents a request to update the Signal Bot API configuration settings.

Logging ​

Defines logging configuration settings for the Signal Bot API.

SetPinRequest ​

Represents a request to set or update the registration lock PIN for the Signal account.

SetUsernameRequest ​

Represents a request to set a unique username for the Signal account, enabling discovery without sharing the phone number.

SyncContactsRequest ​

Represents a request to synchronize the local contact list with Signal's servers to update profile information and registration status.

TrustIdentityRequest ​

Represents a request to mark a contact's identity key as trusted after verifying their safety number.

UnregisterDeviceRequest ​

Represents a request to unregister the current device from Signal and optionally delete the account and local data.

UpdateAccountSettingsRequest ​

Represents a request to update the account privacy and discoverability settings.

UpdateContactRequest ​

Represents a request to update contact information including display name and disappearing message timer.

UpdateGroupRequest ​

Represents a request to update the settings of an existing Signal group.

UpdateProfileRequest ​

Represents a request to update the Signal profile information including name, about text, and avatar image.

VerifyNumberRequest ​

Represents a request to verify a phone number registration using the verification code received via SMS or voice call.