Class TwilioProvider

Implementation of the Twilio provider for sending and receiving messages (SMS, WhatsApp, Facebook Messenger)

Hierarchy (View Summary)

BaseCommunicationProvider
- TwilioProvider

Index

Constructors

constructor

new TwilioProvider(): TwilioProvider
Returns TwilioProvider
Inherited from BaseCommunicationProvider.constructor

Accessors

`Protected`ProviderName

get ProviderName(): string
Returns the name of this provider for use in error messages. Override in subclasses to provide a more descriptive name.

Returns string
Inherited from BaseCommunicationProvider.ProviderName
- Defined in base-types/dist/BaseProvider.d.ts:687

Methods

ArchiveMessage

ArchiveMessage(
params: ArchiveMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<ArchiveMessageResult<Record<string, any>>>
Archives a message. Override in subclasses that support this operation.
Parameters
- params: ArchiveMessageParams
  Parameters for archiving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ArchiveMessageResult<Record<string, any>>>
Promise - Result of the archive operation
Inherited from BaseCommunicationProvider.ArchiveMessage
- Defined in base-types/dist/BaseProvider.d.ts:747

CreateDraft

CreateDraft(
params: CreateDraftParams,
credentials?: TwilioCredentials,
): Promise<CreateDraftResult>
Twilio does not support creating draft messages
Parameters
- params: CreateDraftParams
  Parameters for creating a draft (not used)
- Optionalcredentials: TwilioCredentials
  Optional credentials (not used for Twilio)
Returns Promise<CreateDraftResult>
Overrides BaseCommunicationProvider.CreateDraft
- Defined in providers/twilio/src/TwilioProvider.ts:499

DeleteMessage

DeleteMessage(
params: DeleteMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<DeleteMessageResult<Record<string, any>>>
Deletes a message. Override in subclasses that support this operation.
Parameters
- params: DeleteMessageParams
  Parameters for deleting the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<DeleteMessageResult<Record<string, any>>>
Promise - Result of the delete operation
Inherited from BaseCommunicationProvider.DeleteMessage
- Defined in base-types/dist/BaseProvider.d.ts:715

DownloadAttachment

DownloadAttachment(
params: DownloadAttachmentParams,
credentials?: ProviderCredentialsBase,
): Promise<DownloadAttachmentResult<Record<string, any>>>
Downloads an attachment from a message. Override in subclasses that support this operation.
Parameters
- params: DownloadAttachmentParams
  Parameters for downloading the attachment
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<DownloadAttachmentResult<Record<string, any>>>
Promise - The attachment content
Inherited from BaseCommunicationProvider.DownloadAttachment
- Defined in base-types/dist/BaseProvider.d.ts:771

ForwardMessage

ForwardMessage(
params: ForwardMessageParams,
credentials?: TwilioCredentials,
): Promise<ForwardMessageResult>
Forward a message using Twilio Note: Twilio doesn't have a native "forward" concept, so we implement it as a new message that includes the content of the original message
Parameters
- params: ForwardMessageParams
  Parameters for forwarding a message
- Optionalcredentials: TwilioCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<ForwardMessageResult>
Overrides BaseCommunicationProvider.ForwardMessage
- Defined in providers/twilio/src/TwilioProvider.ts:432

GetMessages

GetMessages(
params: GetMessagesParams,
credentials?: TwilioCredentials,
): Promise<GetMessagesResult>
Gets messages from Twilio
Parameters
- params: GetMessagesParams
  Parameters for fetching messages
- Optionalcredentials: TwilioCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<GetMessagesResult>
Overrides BaseCommunicationProvider.GetMessages
- Defined in providers/twilio/src/TwilioProvider.ts:289

GetSingleMessage

GetSingleMessage(
params: GetSingleMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<GetSingleMessageResult<Record<string, any>>>
Gets a single message by ID. Override in subclasses that support this operation.
Parameters
- params: GetSingleMessageParams
  Parameters for retrieving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<GetSingleMessageResult<Record<string, any>>>
Promise - The retrieved message
Inherited from BaseCommunicationProvider.GetSingleMessage
- Defined in base-types/dist/BaseProvider.d.ts:707

getSupportedOperations

getSupportedOperations(): ProviderOperation[]
Returns the list of operations supported by the Twilio provider. Twilio is a messaging provider (SMS, WhatsApp, Messenger) and does not support mailbox operations like folders, archiving, or attachments.

Returns ProviderOperation[]
Overrides BaseCommunicationProvider.getSupportedOperations
- Defined in providers/twilio/src/TwilioProvider.ts:79

ListAttachments

ListAttachments(
params: ListAttachmentsParams,
credentials?: ProviderCredentialsBase,
): Promise<ListAttachmentsResult<Record<string, any>>>
Lists attachments on a message. Override in subclasses that support this operation.
Parameters
- params: ListAttachmentsParams
  Parameters for listing attachments
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ListAttachmentsResult<Record<string, any>>>
Promise - The list of attachments
Inherited from BaseCommunicationProvider.ListAttachments
- Defined in base-types/dist/BaseProvider.d.ts:763

ListFolders

ListFolders(
params: ListFoldersParams,
credentials?: ProviderCredentialsBase,
): Promise<ListFoldersResult<Record<string, any>>>
Lists folders/mailboxes available in the provider. Override in subclasses that support this operation.
Parameters
- params: ListFoldersParams
  Parameters for listing folders
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<ListFoldersResult<Record<string, any>>>
Promise - The list of folders
Inherited from BaseCommunicationProvider.ListFolders
- Defined in base-types/dist/BaseProvider.d.ts:731

MarkAsRead

MarkAsRead(
params: MarkAsReadParams,
credentials?: ProviderCredentialsBase,
): Promise<MarkAsReadResult<Record<string, any>>>
Marks message(s) as read or unread. Override in subclasses that support this operation.
Parameters
- params: MarkAsReadParams
  Parameters for marking messages
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<MarkAsReadResult<Record<string, any>>>
Promise - Result of the operation
Inherited from BaseCommunicationProvider.MarkAsRead
- Defined in base-types/dist/BaseProvider.d.ts:739

MoveMessage

MoveMessage(
params: MoveMessageParams,
credentials?: ProviderCredentialsBase,
): Promise<MoveMessageResult<Record<string, any>>>
Moves a message to a different folder. Override in subclasses that support this operation.
Parameters
- params: MoveMessageParams
  Parameters for moving the message
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<MoveMessageResult<Record<string, any>>>
Promise - Result of the move operation
Inherited from BaseCommunicationProvider.MoveMessage
- Defined in base-types/dist/BaseProvider.d.ts:723

ReplyToMessage

ReplyToMessage(
params: ReplyToMessageParams,
credentials?: TwilioCredentials,
): Promise<ReplyToMessageResult>
Reply to a message using Twilio
Parameters
- params: ReplyToMessageParams
  Parameters for replying to a message
- Optionalcredentials: TwilioCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<ReplyToMessageResult>
Overrides BaseCommunicationProvider.ReplyToMessage
- Defined in providers/twilio/src/TwilioProvider.ts:354

SearchMessages

SearchMessages(
params: SearchMessagesParams,
credentials?: ProviderCredentialsBase,
): Promise<SearchMessagesResult<Record<string, any>>>
Searches messages using a query string. Override in subclasses that support this operation.
Parameters
- params: SearchMessagesParams
  Parameters for searching messages
- Optionalcredentials: ProviderCredentialsBase
  Optional credentials override for this request
Returns Promise<SearchMessagesResult<Record<string, any>>>
Promise - Messages matching the search criteria
Inherited from BaseCommunicationProvider.SearchMessages
- Defined in base-types/dist/BaseProvider.d.ts:755

SendSingleMessage

SendSingleMessage(
message: ProcessedMessage,
credentials?: TwilioCredentials,
): Promise<MessageResult>
Sends a single message using Twilio
Parameters
- message: ProcessedMessage
  The message to send
- Optionalcredentials: TwilioCredentials
  Optional credentials override for this request. If not provided, uses environment variables. Set credentials.disableEnvironmentFallback = true to require explicit credentials.
Returns Promise<MessageResult>
Overrides BaseCommunicationProvider.SendSingleMessage
- Defined in providers/twilio/src/TwilioProvider.ts:202

supportsOperation

supportsOperation(operation: ProviderOperation): boolean
Checks if this provider supports a specific operation.
Parameters
- operation: ProviderOperation
  The operation to check
Returns boolean
true if the operation is supported
Inherited from BaseCommunicationProvider.supportsOperation
- Defined in base-types/dist/BaseProvider.d.ts:699

Class TwilioProvider

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns TwilioProvider

Accessors

ProtectedProviderName

Returns string

Methods

ArchiveMessage

Parameters

Returns Promise<ArchiveMessageResult<Record<string, any>>>

CreateDraft

Parameters

Returns Promise<CreateDraftResult>

DeleteMessage

Parameters

Returns Promise<DeleteMessageResult<Record<string, any>>>

DownloadAttachment

Parameters

Returns Promise<DownloadAttachmentResult<Record<string, any>>>

ForwardMessage

Parameters

Returns Promise<ForwardMessageResult>

GetMessages

Parameters

Returns Promise<GetMessagesResult>

GetSingleMessage

Parameters

Returns Promise<GetSingleMessageResult<Record<string, any>>>

getSupportedOperations

Returns ProviderOperation[]

ListAttachments

Parameters

Returns Promise<ListAttachmentsResult<Record<string, any>>>

ListFolders

Parameters

Returns Promise<ListFoldersResult<Record<string, any>>>

MarkAsRead

Parameters

Returns Promise<MarkAsReadResult<Record<string, any>>>

MoveMessage

Parameters

Returns Promise<MoveMessageResult<Record<string, any>>>

ReplyToMessage

Parameters

Returns Promise<ReplyToMessageResult>

SearchMessages

Parameters

Returns Promise<SearchMessagesResult<Record<string, any>>>

SendSingleMessage

Parameters

Returns Promise<MessageResult>

supportsOperation

Parameters

Returns boolean

Settings

On This Page

`Protected`ProviderName