Vonage is a cloud communications platform with APIs for SMS, voice, video, and messaging apps such as WhatsApp. Its SMS API sends text messages from virtual numbers that you buy in the Vonage dashboard.
How does the integration work?
You can use the Vonage provider in Appwrite Messaging to send customized SMS messages to your users, such as reminders, promotions, announcements, and custom authentication flows. Messages can be sent immediately or scheduled, to topics, users, or individual targets.
Appwrite authenticates with Vonage using your API key and API secret, and sends your messages through the Vonage SMS API.
How to implement
To implement the Vonage provider in Appwrite Messaging, there are several steps you must complete:
Step 1: Set up Vonage
First, sign up for a Vonage account and buy a virtual number with SMS capability. Then save the following information from the Vonage dashboard:
| Field name | |
|---|---|
| API key | Head to Build & manage > API settings and copy the API key. |
| API secret | Head to Build & manage > API settings and copy the API secret. |
| Sender number | Head to Build & manage > Numbers > Your numbers to find the number your SMS messages are sent from. |
Step 2: Add the Vonage provider to your Appwrite project
For this step, you must create an account on Appwrite Cloud or self-host Appwrite if you haven't already. In your Appwrite project, head to Messaging > Providers, click Add provider, and choose SMS. Give your provider a name, choose Vonage, and click Save and continue.
In the Configure step, add the API key and API secret you saved from the Vonage dashboard. Enter the Sender number with a leading + and the country code, such as +14155550123. Click Save and continue to enable the provider.
Step 3: Test the Vonage provider
Before you proceed, you must already have at least one topic or target set up.
Go to Messaging > Messages, click Create message, and choose SMS. Write a test message, select one of your test targets, set the schedule to Now, and click Send. Check that the SMS arrives on your phone. If it doesn't, check the logs in the Appwrite Console and in your Vonage dashboard.
To send SMS messages from your backend instead, follow the Send SMS messages guide with an Appwrite Server SDK.
Read more about Vonage and Appwrite Messaging
If you would like to learn more about Vonage and Appwrite Messaging, we have some resources that you should visit:
