Send an SMS
In this code snippet you will see how to send an SMS using the Messages API.
For a step-by-step guide to this topic, you can read our tutorial Sending SMS messages with the Messages API.
Delivery receipts
The webhook used for the delivery receipt will depend on the type of authentication used:
Authentication type used | Webhook used for delivery receipt |
---|---|
Basic Auth | account-level webhook is used for delivery receipt. |
JWT Auth | application-level webhook is used for delivery receipt / status. |
Reception of delivery receipts depends on availability of network support.
Example
Find the description for all variables used in each code snippet below:
Key | Description |
---|---|
VONAGE_APPLICATION_ID |
The Vonage Application ID. |
VONAGE_APPLICATION_PRIVATE_KEY_PATH |
Private key path. |
VONAGE_FROM_NUMBER |
Refer to FROM_NUMBER above |
FROM_NUMBER |
The phone number you are sending the message from. |
TO_NUMBER |
The phone number you are sending the message to. |
NOTE: Don't use a leading +
or 00
when entering a phone number, start with the country code, for example 447700900000.
Prerequisites
Write the code
Add the following to send-sms.sh
:
curl -X POST https://api.nexmo.com/v1/messages \
-H 'Authorization: Bearer '$JWT\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d $'{
"message_type": "text",
"text": "Nexmo Verification code: 12345. Valid for 10 minutes.",
"to": "$TO_NUMBER",
"from": "$FROM_NUMBER",
"channel": "sms"
}'
Run your code
Save this file to your machine and run it:
bash send-sms.sh
Prerequisites
npm install @vonage/server-sdk
Create a file named send-sms.js
and add the following code:
const Vonage = require('@vonage/server-sdk')
const SMS = require('@vonage/server-sdk/lib/Messages/SMS');
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET,
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH
})
Write the code
Add the following to send-sms.js
:
vonage.messages.send(
new SMS("This is an SMS text message sent using the Messages API", TO_NUMBER, FROM_NUMBER),
(err, data) => {
if (err) {
console.error(err);
} else {
console.log(data.message_uuid);
}
}
);
Run your code
Save this file to your machine and run it:
node send-sms.js
Prerequisites
gem install vonage
Write the code
Add the following to send-mms.rb
:
client = Vonage::Client.new(
application_id: VONAGE_APPLICATION_ID,
private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)
message = Vonage::Messaging::Message.sms(
message: "A SMS message sent using the Vonage Messages API"
)
client.messaging.send(
from: VONAGE_FROM_NUMBER,
to: TO_NUMBER,
**message
)
Run your code
Save this file to your machine and run it:
ruby send-mms.rb
Try it out
When you run the code a message is sent to the destination number.