Actions84
- Avatar Actions
- Document Actions
- Function Actions
- Messaging Actions
- Create APNS Provider
- Create Email
- Create FCM Provider
- Create Mailgun Provider
- Create MSG91 Provider
- Create Provider
- Create Push
- Create Sendgrid Provider
- Create SMS
- Create SMTP Provider
- Create Subscriber
- Create Telesign Provider
- Create Textmagic Provider
- Create Topic
- Create Twilio Provider
- Create Vonage Provider
- Delete Provider
- Delete Subscriber
- Delete Topic
- Get Message
- Get Provider
- Get Subscriber
- Get Topic
- List Message Logs
- List Messages
- List Provider Logs
- List Providers
- List Subscriber Logs
- List Subscribers
- List Targets
- List Topic Logs
- List Topics
- Update APNS Provider
- Update Email
- Update FCM Provider
- Update Mailgun Provider
- Update MSG91 Provider
- Update Provider
- Update Push
- Update Sendgrid Provider
- Update SMS
- Update SMTP Provider
- Update Telesign Provider
- Update Textmagic Provider
- Update Topic
- Update Twilio Provider
- Update Vonage Provider
- Storage Actions
- Token Actions
- Users Actions
Overview
The "List Providers" operation under the "Messaging" resource in this node allows users to retrieve a list of messaging providers configured in their Appwrite project. Messaging providers are services or configurations used to send messages such as emails, SMS, push notifications, etc.
This operation is useful when you want to:
- Fetch all available messaging providers to display or manage them.
- Filter providers based on specific query parameters.
- Integrate with multiple messaging services and dynamically select providers.
Practical example:
You might use this operation to get all enabled email or SMS providers before sending out a campaign, ensuring you pick the right provider for your message delivery.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional filters to refine the list of providers returned. Supports multiple query types: |
| - Queries | A collection of query conditions to filter the results by attributes such as equality, ordering, limits, offsets, and search keywords. |
The queries can include these options:
- Equal
- Greater Than
- Less Than
- Limit (number of results)
- Not Equal
- Offset (skip results)
- Order Ascending
- Order Descending
- Search (keyword search on string attributes)
Output
The output is a JSON array containing the list of messaging providers matching the query criteria. Each item in the array represents a messaging provider object with its details such as ID, name, type, configuration, and status.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to an Appwrite server via an API key credential.
- The node uses the Appwrite SDK client configured with the project URL, project ID, and API key.
- Proper permissions must be granted to the API key to list messaging providers.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect query parameters may result in empty responses or errors.
- Network connectivity issues with the Appwrite server can cause timeouts or request failures.
Error messages:
- Authentication errors: Check that the API key and project details are correct.
- Query format errors: Ensure query fields and values conform to expected formats.
- Permission denied: Verify the API key has rights to access messaging providers.