Sending an SMS with Unicode

Nexmo's SMS API supports Unicode characters too, which you will need to use when communicating with customers in Chinese, Japanese and Korean.

To send an SMS that contains Unicode characters, replace the following variables in the example below:

Key Description
VONAGE_API_KEY You can find this in your Vonage Dashboard.
VONAGE_API_SECRET You can find this in your Vonage Dashboard.
VONAGE_BRAND_NAME The alphanumeric string that represents the name or number of the organization sending the message.
TO_NUMBER The number you are sending the SMS to, for example 447700900000.

Write the code

Add the following to send-an-sms-with-unicode.sh:

Copy to Clipboard
curl -X "POST" "https://rest.nexmo.com/sms/json" \
  -d "from=$NEXMO_BRAND_NAME" \
  -d "to=$TO_NUMBER" \
  -d "text=こんにちは世界" \
  -d "type=unicode" \
  -d "api_key=$NEXMO_API_KEY" \
  -d "api_secret=$NEXMO_API_SECRET"

View full source

Run your code

Save this file to your machine and run it:

sh send-an-sms-with-unicode.sh

Prerequisites

Install dependencies

npm install @vonage/server-sdk
Initialize your dependencies

Create a file named send-unicode-sms.js and add the following code:

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

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

View full source

Write the code

Add the following to send-unicode-sms.js:

Copy to Clipboard
const from = VONAGE_BRAND_NAME
const to = TO_NUMBER
const text = 'こんにちは世界'
const opts = {
  "type": "unicode"
}

vonage.message.sendSms(from, to, text, opts, (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']}`);
        }
    }
})

View full source

Run your code

Save this file to your machine and run it:

node send-unicode-sms.js

Prerequisites

Install dependencies

Add the following to `build.gradle`:

compile 'com.vonage:client:5.5.0'
Initialize your dependencies

Create a class named SendUnicodeMessage and add the following code to the main method:

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

View full source

Write the code

Add the following to the main method of the SendUnicodeMessage class:

Copy to Clipboard

TextMessage message = new TextMessage(VONAGE_BRAND_NAME, TO_NUMBER, "Blue Öyster Cult \uD83E\uDD18", true);

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

for (SmsSubmissionResponseMessage responseMessage : responses.getMessages()) {
    System.out.println(message);
}

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

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

Run the following gradle command to execute your application, replacing com.vonage.quickstart.sms with the package containing SendUnicodeMessage:

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

Prerequisites

Install dependencies

Install-Package Nexmo.Csharp.Client
Import dependencies

Create a file named SendSmsWithUnicode.cs and add the following code:

Copy to Clipboard
using Vonage;
using Vonage.Messaging;
using Vonage.Request;

View full source

Initialize your dependencies

Add the following to SendSmsWithUnicode.cs:

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

var VonageClient = new VonageClient(credentials);

View full source

Write the code

Add the following to SendSmsWithUnicode.cs:

Copy to Clipboard
var response = VonageClient.SmsClient.SendAnSms(new SendSmsRequest()
{
    To = TO_NUMBER,
    From = VONAGE_BRAND_NAME,
    Text = "こんにちは世界",
    Type = SmsType.unicode
});

View full source

Prerequisites

Install dependencies

composer require nexmo
Initialize your dependencies

Create a file named send-unicode-sms.php and add the following code:

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

View full source

Write the code

Add the following to send-unicode-sms.php:

Copy to Clipboard
$response = $client->sms()->send(
    new \Vonage\SMS\Message\SMS(TO_NUMBER, BRAND_NAME, 'こんにちは世界')
);

var_dump($response->current());

View full source

Run your code

Save this file to your machine and run it:

php send-unicode-sms.php

Prerequisites

Install dependencies

pip install nexmo
Initialize your dependencies

Create a file named send-an-sms-with-unicode.py and add the following code:

Copy to Clipboard
sms = Sms(
        Client(
            key=VONAGE_API_KEY, 
            secret=VONAGE_API_SECRET
        )
    )

View full source

Write the code

Add the following to send-an-sms-with-unicode.py:

Copy to Clipboard
response = sms.send_message({
    'from': VONAGE_BRAND_NAME,
    'to': TO_NUMBER,
    'text': 'こんにちは世界',
    'type': 'unicode',
})

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

View full source

Run your code

Save this file to your machine and run it:

python3 send-an-sms-with-unicode.py

Prerequisites

Install dependencies

gem install vonage
Initialize your dependencies

Create a file named send-unicode-sms.rb and add the following code:

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

View full source

Write the code

Add the following to send-unicode-sms.rb:

Copy to Clipboard
client.sms.send(
  from: 'Acme Inc',
  to: TO_NUMBER,
  text: 'こんにちは世界',
  type: "unicode"
)

View full source

Run your code

Save this file to your machine and run it:

ruby send-unicode-sms.rb

Try it out

When you run the example above, the text message will be sent to the mobile number specified with the Unicode characters intact.

Note that Unicode messages can only contain 70 characters, rather than the usual 160. There's more information about this on the help page

Further reading