SMS Delivery
Appwrite supports phone authentication, which allows users to create accounts and log in using SMS messages. Appwrite requires an SMS provider to be setup before using Phone authentication.
SMS Providers
Appwrite supports a growing list of SMS providers that you can choose from. Choose one from the list below and set up an account.
| SMS Provider | Create Account | Get Credentials | |
|---|---|---|---|
  | Twilio | Website | Documentation |
  | TextMagic | Website | Documentation |
  | Telesign | Website | Documentation |
  | MSG91 | Website | Documentation |
  | Vonage | Website | Documentation |
Update Your .env File
You will need to configure these environment variables and restart your Appwrite containers before you can use phone authentication.
| Provider | _APP_SMS_PROVIDER | _APP_SMS_FROM |
| Twilio | sms://[ACCOUNT SID]:[AUTH TOKEN]@twilio | [TWILIO PHONE NUMBER] |
| TextMagic | sms://[USERNAME]:[API KEY]@text-magic | [PHONE NUMBER OR SENDER ID] |
| TeleSign | sms://[CUSTOMER ID]:[API KEY]:telesign | [TELESIGN PHONE NUMBER] |
| MSG91 | sms://[SENDER ID]:[AUTH KEY]@MSG91 | [FLOW ID] |
| Vonage | sms://[API KEY]:[API SECRET]@vonage | [PHONE NUMBER OR BRAND NAME] |
Restart Your Appwrite Server
Once you've updated your .env file, you need to restart your Appwrite instance. Navigate to the directory containing the docker-compose.yml file of your Appwrite instance and run the following command from your terminal:
docker compose up -dYou can verify if the environment variables have changed by running this command:
docker compose exec appwrite-worker-messaging vars