Quickstart: Send an SMS message

Important

Phone number availability is currently restricted to Azure subscriptions that have a billing address in the United States. For more information, visit the Phone number types documentation.

Important

SMS messages can be sent to and received from United States phone numbers. Phone numbers located in other geographies are not yet supported by Communication Services SMS. For more information, see Phone number types.

Get started with Azure Communication Services by using the Communication Services C# SMS SDK to send SMS messages.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Prerequisites

Prerequisite check

  • In a terminal or command window, run the dotnet command to check that the .NET SDK is installed.
  • To view the phone numbers associated with your Communication Services resource, sign in to the Azure portal, locate your Communication Services resource and open the phone numbers tab from the left navigation pane.

Setting up

Create a new C# application

In a console window (such as cmd, PowerShell, or Bash), use the dotnet new command to create a new console app with the name SmsQuickstart. This command creates a simple "Hello World" C# project with a single source file: Program.cs.

dotnet new console -o SmsQuickstart

Change your directory to the newly created app folder and use the dotnet build command to compile your application.

cd SmsQuickstart
dotnet build

Install the package

While still in the application directory, install the Azure Communication Services SMS SDK for .NET package by using the dotnet add package command.

dotnet add package Azure.Communication.Sms --version 1.0.0

Add a using directive to the top of Program.cs to include the Azure.Communication namespace.


using System;
using System.Collections.Generic;

using Azure;
using Azure.Communication;
using Azure.Communication.Sms;

Object model

The following classes and interfaces handle some of the major features of the Azure Communication Services SMS SDK for C#.

Name Description
SmsClient This class is needed for all SMS functionality. You instantiate it with your subscription information, and use it to send SMS messages.
SmsSendOptions This class provides options to configure delivery reporting. If enable_delivery_report is set to True, then an event will be emitted when delivery was successful
SmsSendResult This class contains the result from the SMS service.

Authenticate the client

Open Program.cs in a text editor and replace the body of the Main method with code to initialize an SmsClient with your connection string. The code below retrieves the connection string for the resource from an environment variable named COMMUNICATION_SERVICES_CONNECTION_STRING. Learn how to manage your resource's connection string.

// This code demonstrates how to fetch your connection string
// from an environment variable.
string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");

SmsClient smsClient = new SmsClient(connectionString);

Send a 1:1 SMS message

To send an SMS message to a single recipient, call the Send or SendAsync function from the SmsClient. Add this code to the end of Main method in Program.cs:

SmsSendResult sendResult = smsClient.Send(
    from: "<from-phone-number>",
    to: "<to-phone-number>",
    message: "Hello World via SMS"
);

Console.WriteLine($"Sms id: {sendResult.MessageId}");

You should replace <from-phone-number> with an SMS-enabled phone number associated with your Communication Services resource and <to-phone-number> with the phone number you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

Send a 1:N SMS message with options

To send an SMS message to a list of recipients, call the Send or SendAsync function from the SmsClient with a list of recipient's phone numbers. You may also pass in optional parameters to specify whether the delivery report should be enabled and to set custom tags.

Response<IReadOnlyList<SmsSendResult>> response = smsClient.Send(
    from: "<from-phone-number>",
    to: new string[] { "<to-phone-number-1>", "<to-phone-number-2>" },
    message: "Weekly Promotion!",
    options: new SmsSendOptions(enableDeliveryReport: true) // OPTIONAL
    {
        Tag = "marketing", // custom tags
    });

IEnumerable<SmsSendResult> results = response.Value;
foreach (SmsSendResult result in results)
{
    Console.WriteLine($"Sms id: {result.MessageId}");
    Console.WriteLine($"Send Result Successful: {result.Successful}");
}

You should replace <from-phone-number> with an SMS-enabled phone number associated with your Communication Services resource and <to-phone-number-1> and <to-phone-number-2> with phone number(s) you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

The enableDeliveryReport parameter is an optional parameter that you can use to configure Delivery Reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered. See the Handle SMS Events quickstart to configure Delivery Reporting for your SMS messages.

Tag is used to apply a tag to the Delivery Report

Run the code

Run the application from your application directory with the dotnet run command.

dotnet run

Sample Code

You can download the sample app from GitHub

Get started with Azure Communication Services by using the Communication Services JavaScript SMS SDK to send SMS messages.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Prerequisites

Prerequisite check

  • In a terminal or command window, run node --version to check that Node.js is installed.
  • To view the phone numbers associated with your Communication Services resource, sign in to the Azure portal, locate your Communication Services resource and open the phone numbers tab from the left navigation pane.

Setting up

Create a new Node.js Application

First, open your terminal or command window, create a new directory for your app, and navigate to it.

mkdir sms-quickstart && cd sms-quickstart

Run npm init -y to create a package.json file with default settings.

npm init -y

Use a text editor to create a file called send-sms.js in the project root directory. You'll add all the source code for this quickstart to this file in the following sections.

Install the package

Use the npm install command to install the Azure Communication Services SMS SDK for JavaScript.

npm install @azure/communication-sms --save

The --save option lists the library as a dependency in your package.json file.

Object model

The following classes and interfaces handle some of the major features of the Azure Communication Services SMS SDK for Node.js.

Name Description
SmsClient This class is needed for all SMS functionality. You instantiate it with your subscription information, and use it to send SMS messages.
SmsSendRequest This interface is the model for building the sms request (eg. configure the to and from phone numbers and the sms content).
SmsSendOptions This interface provides options to configure delivery reporting. If enableDeliveryReport is set to true, then an event will be emitted when delivery is successful.
SmsSendResult This class contains the result from the SMS service.

Authenticate the client

Import the SmsClient from the SDK and instantiate it with your connection string. The code below retrieves the connection string for the resource from an environment variable named COMMUNICATION_SERVICES_CONNECTION_STRING. Learn how to manage your resource's connection string.

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

const { SmsClient } = require('@azure/communication-sms');

// This code demonstrates how to fetch your connection string
// from an environment variable.
const connectionString = process.env['COMMUNICATION_SERVICES_CONNECTION_STRING'];

// Instantiate the SMS client
const smsClient = new SmsClient(connectionString);

Send a 1:N SMS message

To send an SMS message to a list of recipients, call the send function from the SmsClient with a list of recipients phone numbers (if you wish to send a message to a single recipient, only include one number in the list). Add this code to the end of send-sms.js:

async function main() {
  const sendResults = await smsClient.send({
    from: "<from-phone-number>",
    to: ["<to-phone-number-1>", "<to-phone-number-2>"],
    message: "Hello World 👋🏻 via SMS"
  });

  // individual messages can encounter errors during sending
  // use the "successful" property to verify
  for (const sendResult of sendResults) {
    if (sendResult.successful) {
      console.log("Success: ", sendResult);
    } else {
      console.error("Something went wrong when trying to send this message: ", sendResult);
    }
  }
}

main();

You should replace <from-phone-number> with an SMS-enabled phone number associated with your Communication Services resource and <to-phone-number-1> and <to-phone-number-2> with the phone number(s) you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

Send a 1:N SMS message with options

You may also pass in an options object to specify whether the delivery report should be enabled and to set custom tags.


async function main() {
  const sendResults = await smsClient.send({
    from: "<from-phone-number>",
    to: ["<to-phone-number-1>", "<to-phone-number-2>"],
    message: "Weekly Promotion!"
  }, {
    //Optional parameters
    enableDeliveryReport: true,
    tag: "marketing"
  });

  // individual messages can encounter errors during sending
  // use the "successful" property to verify
  for (const sendResult of sendResults) {
    if (sendResult.successful) {
      console.log("Success: ", sendResult);
    } else {
      console.error("Something went wrong when trying to send this message: ", sendResult);
    }
  }
}

main();

You should replace <from-phone-number> with an SMS-enabled phone number associated with your Communication Services resource and <to-phone-number-1> and <to-phone-number-2> with phone number(s) you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

The enableDeliveryReport parameter is an optional parameter that you can use to configure Delivery Reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered. See the Handle SMS Events quickstart to configure Delivery Reporting for your SMS messages. tag is an optional parameter that you can use to apply a tag to the Delivery Report.

Run the code

Use the node command to run the code you added to the send-sms.js file.


node ./send-sms.js

Get started with Azure Communication Services by using the Communication Services Python SMS SDK to send SMS messages.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Prerequisites

Prerequisite check

  • In a terminal or command window, run the python --version command to check that Python is installed.
  • To view the phone numbers associated with your Communication Services resource, sign in to the Azure portal, locate your Communication Services resource and open the phone numbers tab from the left navigation pane.

Setting up

Create a new Python application

Open your terminal or command window, create a new directory for your app, and navigate to it.

mkdir sms-quickstart && cd sms-quickstart

Use a text editor to create a file called send-sms.py in the project root directory and add the structure for the program, including basic exception handling. You'll add all the source code for this quickstart to this file in the following sections.

import os
from azure.communication.sms import SmsClient

try:
    # Quickstart code goes here
except Exception as ex:
    print('Exception:')
    print(ex)

Install the package

While still in the application directory, install the Azure Communication Services SMS SDK for Python package by using the pip install command.

pip install azure-communication-sms

Object model

The following classes and interfaces handle some of the major features of the Azure Communication Services SMS SDK for Python.

Name Description
SmsClient This class is needed for all SMS functionality. You instantiate it with your subscription information, and use it to send SMS messages.
SmsSendResult This class contains the result from the SMS service.

Authenticate the client

Instantiate an SmsClient with your connection string. Learn how to manage your resource's connection string.

# Create the SmsClient object which will be used to send SMS messages
sms_client = SmsClient.from_connection_string(<connection_string>)

For simplicity we are using connection strings in this quickstart, but in production environments we recommend using managed identities because they are more secure and manageable at scale.

Send a 1:1 SMS Message

To send an SMS message to a single recipient, call the send method from the SmsClient with a single recipient phone number. You may also pass in optional parameters to specify whether the delivery report should be enabled and to set custom tags. Add this code to the end of try block in send-sms.py:


# calling send() with sms values
sms_responses = sms_client.send(
    from_="<from-phone-number>",
    to="<to-phone-number>",
    message="Hello World via SMS",
    enable_delivery_report=True, # optional property
    tag="custom-tag") # optional property

You should replace <from-phone-number> with an SMS enabled phone number associated with your communication service and <to-phone-number> with the phone number you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

Send a 1:N SMS Message

To send an SMS message to a list of recipients, call the send method from the SmsClient with a list of recipient's phone numbers. You may also pass in optional parameters to specify whether the delivery report should be enabled and to set custom tags. Add this code to the end of try block in send-sms.py:


# calling send() with sms values
sms_responses = sms_client.send(
    from_="<from-phone-number>",
    to=["<to-phone-number-1>", "<to-phone-number-2>"],
    message="Hello World via SMS",
    enable_delivery_report=True, # optional property
    tag="custom-tag") # optional property

You should replace <from-phone-number> with an SMS enabled phone number associated with your communication service and <to-phone-number-1> <to-phone-number-2> with phone number(s) you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

Optional Parameters

The enable_delivery_report parameter is an optional parameter that you can use to configure Delivery Reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered. See the Handle SMS Events quickstart to configure Delivery Reporting for your SMS messages.

The tag parameter is an optional parameter that you can use to apply a tag to the Delivery Report.

Run the code

Run the application from your application directory with the python command.

python send-sms.py

The complete Python script should look something like:


import os
from azure.communication.sms import SmsClient

try:
    # Create the SmsClient object which will be used to send SMS messages
    sms_client = SmsClient.from_connection_string("<connection string>")
    # calling send() with sms values
    sms_responses = sms_client.send(
       from_="<from-phone-number>",
       to="<to-phone-number>",
       message="Hello World via SMS",
       enable_delivery_report=True, # optional property
       tag="custom-tag") # optional property

except Exception as ex:
    print('Exception:')
    print(ex)

Get started with Azure Communication Services by using the Communication Services Java SMS SDK to send SMS messages.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Prerequisites

Prerequisite check

  • In a terminal or command window, run mvn -v to check that maven is installed.
  • To view the phone numbers associated with your Communication Services resource, sign in to the Azure portal, locate your Communication Services resource and open the phone numbers tab from the left navigation pane.

Setting up

Create a new Java application

Open your terminal or command window and navigate to the directory where you would like to create your Java application. Run the command below to generate the Java project from the maven-archetype-quickstart template.

mvn archetype:generate -DgroupId=com.communication.quickstart -DartifactId=communication-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

The 'generate' goal will create a directory with the same name as the artifactId. Under this directory, the src/main/java directory contains the project source code, the src/test/java directory contains the test source, and the pom.xml file is the project's Project Object Model, or POM.

Install the package

Open the pom.xml file in your text editor. Add the following dependency element to the group of dependencies.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-sms</artifactId>
    <version>1.0.0</version>
</dependency>

Set up the app framework

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-core</artifactId>
    <version>1.13.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} -->
</dependency>

Open /src/main/java/com/communication/quickstart/App.java in a text editor, add import directives and remove the System.out.println("Hello world!"); statement:

package com.communication.quickstart;

import com.azure.communication.sms.models.*;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.communication.sms.*;
import com.azure.core.util.Context;
import java.util.Arrays;

public class App
{
    public static void main( String[] args )
    {
        // Quickstart code goes here
    }
}

Object model

The following classes and interfaces handle some of the major features of the Azure Communication Services SMS SDK for Java.

Name Description
SmsClientBuilder This class creates the SmsClient. You provide it with endpoint, credential, and an http client.
SmsClient This class is needed for all SMS functionality. You use it to send SMS messages.
SmsSendOptions This class provides options to add custom tags and configure delivery reporting. If deliveryReportEnabled is set to true, then an event will be emitted when delivery was successful
SmsSendResult This class contains the result from the SMS service.

Authenticate the client

Instantiate an SmsClient with your connection string. (Credential is the Key from the Azure portal. Learn how to manage your resource's connection string. In addition, you can initialize the client with any custom HTTP client the implements the com.azure.core.http.HttpClient interface.

Add the following code to the main method:

// You can find your endpoint and access key from your resource in the Azure portal
String endpoint = "https://<resource-name>.communication.azure.com/";
AzureKeyCredential azureKeyCredential = new AzureKeyCredential("<access-key-credential>");

SmsClient smsClient = new SmsClientBuilder()
                .endpoint(endpoint)
                .credential(azureKeyCredential)
                .buildClient();

You can also provide the entire connection string using the connectionString() function instead of providing the endpoint and access key.

// You can find your connection string from your resource in the Azure portal
String connectionString = "https://<resource-name>.communication.azure.com/;<access-key>";

SmsClient smsClient = new SmsClientBuilder()
            .connectionString(connectionString)
            .buildClient();

Send a 1:1 SMS message

To send an SMS message to a single recipient, call the send method from the SmsClient with a single recipient phone number. You may also pass in optional parameters to specify whether the delivery report should be enabled and to set custom tags.

SmsSendResult sendResult = smsClient.send(
                "<from-phone-number>",
                "<to-phone-number>",
                "Weekly Promotion");

System.out.println("Message Id: " + sendResult.getMessageId());
System.out.println("Recipient Number: " + sendResult.getTo());
System.out.println("Send Result Successful:" + sendResult.isSuccessful());

You should replace <from-phone-number> with an SMS enabled phone number associated with your Communication Services resource and <to-phone-number> with a phone number you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

Send a 1:N SMS message with options

To send an SMS message to a list of recipients, call the send method with a list of recipient phone numbers. You may also pass in optional parameters to specify whether the delivery report should be enabled and to set custom tags.

SmsSendOptions options = new SmsSendOptions();
options.setDeliveryReportEnabled(true);
options.setTag("Marketing");

Iterable<SmsSendResult> sendResults = smsClient.sendWithResponse(
    "<from-phone-number>",
    Arrays.asList("<to-phone-number1>", "<to-phone-number2>"),
    "Weekly Promotion",
    options /* Optional */,
    Context.NONE).getValue();

for (SmsSendResult result : sendResults) {
    System.out.println("Message Id: " + result.getMessageId());
    System.out.println("Recipient Number: " + result.getTo());
    System.out.println("Send Result Successful:" + result.isSuccessful());
}

You should replace <from-phone-number> with an SMS enabled phone number associated with your Communication Services resource and <to-phone-number-1> and <to-phone-number-2> with phone number(s) you wish to send a message to.

Warning

Note that phone numbers should be provided in E.164 international standard format. (e.g.: +14255550123).

The setDeliveryReportEnabled method is used to configure Delivery Reporting. This is useful for scenarios where you want to emit events when SMS messages are delivered. See the Handle SMS Events quickstart to configure Delivery Reporting for your SMS messages.

The setTag method is used to apply a tag to the Delivery Report.

Run the code

Navigate to the directory containing the pom.xml file and compile the project using the mvn command.


mvn compile

Then, build the package.


mvn package

Run the following mvn command to execute the app.


mvn exec:java -Dexec.mainClass="com.communication.quickstart.App" -Dexec.cleanupDaemonThreads=false

Troubleshooting

To troubleshoot issues related to SMS delivery, you can enable delivery reporting with Event Grid to capture delivery details.

Clean up resources

If you want to clean up and remove a Communication Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with it. Learn more about cleaning up resources.

Next steps

In this quickstart, you learned how to send SMS messages using Azure Communication Services.