Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Messaging → Send SMS

AI-generated

Overview

This node integrates with the Appwrite API to send SMS messages as part of its Messaging resource operations. It allows users to send SMS messages to specified recipients, including individual users, topics, or targets. The node supports sending messages immediately or saving them as drafts. This is useful for automating SMS notifications, alerts, or marketing messages within workflows.

Use Case Examples

  1. Send an SMS notification to a list of users about an upcoming event.
  2. Send a promotional SMS message to subscribers of specific topics.
  3. Save an SMS message as a draft for review before sending.

Properties

Name Meaning
Content The text content of the SMS message to be sent.
Topics Comma-separated list of topic IDs to send the SMS message to.
Users Comma-separated list of user IDs to send the SMS message to.
Targets Comma-separated list of target IDs to send the SMS message to.
Draft Boolean flag indicating whether to save the message as a draft instead of sending immediately.
Message ID Unique identifier for the SMS message, can be generated automatically using unique().

Output

JSON

  • messageId - The unique identifier of the sent or drafted SMS message.
  • status - The status of the SMS message, e.g., sent, draft, or failed.
  • recipients - Details of the recipients the SMS message was sent to, including users, topics, or targets.
  • content - The text content of the SMS message.

Dependencies

  • Appwrite API endpoint
  • Project ID
  • API key credential for authentication

Troubleshooting

  • Ensure the API credentials (endpoint, project ID, API key) are correctly configured and valid.
  • Verify that the message content is not empty as it is required.
  • Check that the recipient IDs (users, topics, targets) are correctly formatted as comma-separated strings.
  • If saving as draft, confirm that the draft flag is set correctly; otherwise, the message will be sent immediately.
  • Handle API errors gracefully, and use the node's continueOnFail option to manage failures without stopping the workflow.

Discussion