SMS API

Vonage's SMS API enables you to send and receive text messages to and from users worldwide, using simple REST APIs.

• Programmatically send and receive high volumes of SMS globally.
• Send SMS with low latency and high delivery rates.
• Receive SMS using local numbers.
• Scale your applications with familiar web technologies.
• Pay only for what you use, nothing more.
• Auto-redact feature to protect privacy.

Contents

This topic contains the following information:

• Getting Started - Information on how to get started quickly
• Troubleshooting - Message object status field and error code information
• Concepts - Introductory concepts
• Guides - Learn how to use the SMS API
• Code Snippets - Code snippets to help with specific tasks
• Use Cases - Use cases with code examples
• Reference - REST API documentation

Getting Started

Send an SMS

This example shows you how to send an SMS to your chosen number.

First, sign up for a Nexmo account if you don't already have one, and make a note of your API key and secret on the dashboard getting started page.

Replace the following placeholder values in the sample code:

curl -X "POST" "https://rest.nexmo.com/sms/json" \
  -d "from=$NEXMO_BRAND_NAME" \
  -d "text=A text message sent using the Nexmo SMS API" \
  -d "to=$TO_NUMBER" \
  -d "api_key=$NEXMO_API_KEY" \
  -d "api_secret=$NEXMO_API_SECRET"

sh send-sms.sh

npm install @vonage/server-sdk

const Vonage = require('@vonage/server-sdk')

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
})

const from = VONAGE_BRAND_NAME
const to = TO_NUMBER
const text = 'A text message sent using the Vonage SMS API'

vonage.message.sendSms(from, to, text, (err, responseData) => {
    if (err) {
        console.log(err);
    } else {
        if(responseData.messages[0]['status'] === "0") {
            console.log("Message sent successfully.");
        } else {
            console.log(`Message failed with error: ${responseData.messages[0]['error-text']}`);
        }
    }
})

node send.js

compile 'com.vonage:client:5.5.0'

VonageClient client = VonageClient.builder().apiKey(VONAGE_API_KEY).apiSecret(VONAGE_API_SECRET).build();

TextMessage message = new TextMessage(VONAGE_BRAND_NAME,
        TO_NUMBER,
        "A text message sent using the Vonage SMS API"
);

SmsSubmissionResponse response = client.getSmsClient().submitMessage(message);

if (response.getMessages().get(0).getStatus() == MessageStatus.OK) {
    System.out.println("Message sent successfully.");
} else {
    System.out.println("Message failed with error: " + response.getMessages().get(0).getErrorText());
}

  apply plugin: 'application'
  mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

gradle run -Pmain=com.vonage.quickstart.sms.SendMessage

Install-Package Nexmo.Csharp.Client

using Vonage;
using Vonage.Request;

var credentials = Credentials.FromApiKeyAndSecret(
    VONAGE_API_KEY,
    VONAGE_API_SECRET
    );

var VonageClient = new VonageClient(credentials);

var response = VonageClient.SmsClient.SendAnSms(new Vonage.Messaging.SendSmsRequest()
{
    To = TO_NUMBER,
    From = VONAGE_BRAND_NAME,
    Text = "A text message sent using the Vonage SMS API"
});

composer require nexmo/client

$basic  = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);

$response = $client->sms()->send(
    new \Vonage\SMS\Message\SMS(TO_NUMBER, BRAND_NAME, 'A text message sent using the Nexmo SMS API')
);

$message = $response->current();

if ($message->getStatus() == 0) {
    echo "The message was sent successfully\n";
} else {
    echo "The message failed with status: " . $message->getStatus() . "\n";
}

php send-sms.php

pip install nexmo

client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
sms = vonage.Sms(client)

responseData = sms.send_message(
    {
        "from": VONAGE_BRAND_NAME,
        "to": TO_NUMBER,
        "text": "A text message sent using the Nexmo SMS API",
    }
)

if responseData["messages"][0]["status"] == "0":
    print("Message sent successfully.")
else:
    print(f"Message failed with error: {responseData['messages'][0]['error-text']}")

python send-an-sms.py

gem install vonage

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

client.sms.send(
  from: 'Acme Inc',
  to: TO_NUMBER,
  text: 'A text message sent using the Vonage SMS API'
)

ruby send.rb

Troubleshooting

If you have problems when making API calls be sure to check the returned status field for specific error codes.

Concepts

Before using the Nexmo SMS API, familiarize yourself with the following:

• Number format - The SMS API requires phone numbers in E.164 format.

• Authentication - The SMS API authenticates using your account API key and secret.

• Webhooks - The SMS API makes HTTP requests to your application web server so that you can act upon them. For example: inbound SMS and delivery receipts.

Guides

• Sender identity: How to change where your SMS appears to come from.
• Concatenation and encoding: Determining whether the byte length of a message results in it being sent as multiple SMS.
• Country specific features: How different countries' SMS sending rules can affect your campaign.
• Delivery receipts: How to request a delivery receipt (DLR) from the carrier.
• Inbound SMS: How to receive SMS on your Nexmo virtual numbers.
• Troubleshooting: What to do if your SMS delivery fails.
• SMPP access: Using SMPP instead of REST to access the SMS API.

Code Snippets

• 始める前に
• Before you begin
• SMS を送信
• Send an SMS
• Unicode を含む SMS を送信
• Send an SMS with Unicode
• 受信確認
• Delivery Receipts
• SMS を受信
• Receive an SMS

Use Cases

• SMS Customer Support
• Two-way SMS for customer engagement
• Mobile app invites
• Receiving Concatenated SMS
• Private SMS communication

Reference

• SMS API Reference
• Response object status field
• Error codes