Quickstart: Een sms-bericht verzenden

Ga aan de slag Azure Communication Services met de Communication Services sms-SDK voor C# om sms-berichten te verzenden.

Voor het voltooien van deze quickstart worden kosten van een paar dollarcent of minder in rekening gebracht bij uw Azure-account.

Vereisten

• Een Azure-account met een actief abonnement. Gratis een account maken
• De nieuwste versie .NET Core SDK voor uw besturingssysteem.
• Een actieve Communication Services-resource en verbindingsreeks. Een Communication Services-resource maken.
• Een telefoonnummer met sms-functionaliteit. Een telefoonnummer aanvragen.

Controle van vereisten

• Voer in een terminal- of opdrachtvenster de opdracht dotnet uit om te controleren of de .NET SDK is geïnstalleerd.
• Als u de telefoonnummers wilt weergeven die zijn gekoppeld aan uw Communication Services-resource, meldt u zich aan bij Azure Portal, zoekt u uw Communication Services-resource en opent u het tabblad telefoonnummers vanuit het navigatiedeelvenster aan de linkerkant.

Instellen

Een nieuwe C#-toepassing maken

Gebruik in een consolevenster (zoals cmd, PowerShell of Bash) de opdracht dotnet new om een nieuwe console-app te maken met de naam SmsQuickstart. Met deze opdracht maakt u een eenvoudig Hallo wereld-C#-project met één bronbestand: Program.cs.

dotnet new console -o SmsQuickstart

Wijzig uw map in de zojuist gemaakte app-map en gebruik de opdracht dotnet build om uw toepassing te compileren.

cd SmsQuickstart
dotnet build

Het pakket installeren

Terwijl u zich nog steeds in de toepassingsmap blijft, installeert u de Azure Communication Services SMS SDK voor het .NET-pakket met behulp van de dotnet add package opdracht .

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

Voeg een using-instructie toe aan het begin van Program.cs om de naamruimte Azure.Communication op te nemen.

using System;
using System.Collections.Generic;

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

Objectmodel

De volgende klassen en interfaces verwerken enkele van de belangrijkste functies van de Azure Communication Services SMS SDK voor C#.

Naam	Beschrijving
SmsClient	Deze klasse is vereist voor alle sms-functionaliteit. U instantieert deze klasse met uw abonnementsgegevens en gebruikt deze om sms-berichten te verzenden.
SmsSendOptions	Deze klasse biedt opties voor het configureren van leveringsrapporten. Als enable_delivery_report is ingesteld op True, wordt een gebeurtenis verzonden wanneer de levering is geslaagd
SmsSendResult	Deze klasse bevat het resultaat van de SMS-service.

De client verifiëren

Open Program.cs in een teksteditor en vervang de hoofdtekst van de Main-methode door code om een SmsClient te initialiseren met uw verbindingsreeks. Met de onderstaande code wordt de verbindingsreeks voor de resource opgehaald uit een omgevingsvariabele met de naam COMMUNICATION_SERVICES_CONNECTION_STRING. Meer informatie over het beheren van de 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);

Een 1:1 sms-bericht verzenden

Als u een sms-bericht naar één ontvanger wilt verzenden, roept u de Send functie or aan vanuit de SendAsync SmsClient. Voeg deze code toe aan het einde van de Main-methode 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}");

U moet <from-phone-number> vervangen door een telefoonnummer met sms-functionaliteit dat is gekoppeld aan uw Communication Services-resources en <to-phone-number> met het telefoonnummer waarnaar u een bericht wilt verzenden.

Een 1:N sms-bericht met opties verzenden

Als u een sms-bericht wilt verzenden naar een lijst met ontvangers, roept u de functie or aan vanuit de SmsClient met een lijst met Send SendAsync telefoonnummers van de ontvanger. U kunt ook optionele parameters doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen.

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}");
}

Vervang door een telefoonnummer met sms-functie dat is gekoppeld aan uw Communication Services-resource en door een of meer telefoonnummers waar u een bericht <from-phone-number> <to-phone-number-1> naar wilt <to-phone-number-2> verzenden.

De parameter enableDeliveryReport is een optionele parameter die u kunt gebruiken voor het configureren van leveringsrapporten. Dit is handig voor scenario's waarin u gebeurtenissen wilt verzenden wanneer sms-berichten worden bezorgd. Raadpleeg de quickstart Sms-gebeurtenissen verwerken voor het configureren van leveringsrapporten voor uw sms-berichten.

Tag wordt gebruikt om een tag toe te passen op het leveringsrapport

De code uitvoeren

Voer de toepassing op vanuit uw toepassingsmap met de opdracht dotnet run.

dotnet run

Voorbeeldcode

U kunt de voorbeeld-app downloaden uit GitHub.

Ga aan de slag Azure Communication Services met behulp van Communication Services JavaScript SMS SDK voor het verzenden van sms-berichten.

Voor het voltooien van deze quickstart worden kosten van een paar dollarcent of minder in rekening gebracht bij uw Azure-account.

Vereisten

• Een Azure-account met een actief abonnement. Gratis een account maken
• Node.js, Active LTS en Maintenance LTS-versies (8.11.1 en 10.14.1 aanbevolen).
• Een actieve Communication Services-resource en verbindingsreeks. Een Communication Services-resource maken.
• Een telefoonnummer met sms-functionaliteit. Een telefoonnummer aanvragen.

Controle van vereisten

• Voer node --version in een terminal of opdrachtvenster uit om te controleren of Node.js is geïnstalleerd.
• Als u de telefoonnummers wilt weergeven die zijn gekoppeld aan uw Communication Services-resource, meldt u zich aan bij Azure Portal, zoekt u uw Communication Services-resource en opent u het tabblad telefoonnummers vanuit het navigatiedeelvenster aan de linkerkant.

Instellen

Een nieuwe Node.js-toepassing maken

Open eerst uw terminal of opdrachtvenster, maak een nieuwe map voor uw app en navigeer daar naartoe.

mkdir sms-quickstart && cd sms-quickstart

Voer npm init -y uit om een package.json-bestand te maken met de standaardinstellingen.

npm init -y

Gebruik een teksteditor om een bestand met de naam send-sms.js te maken in de hoofdmap van het project. In de volgende secties voegt u alle broncode voor deze quickstart toe aan dit bestand.

Het pakket installeren

Gebruik de npm install opdracht om de Azure Communication Services SMS SDK voor JavaScript te installeren.

npm install @azure/communication-sms --save

De optie --save geeft de bibliotheek weer als afhankelijkheid in het package.json-bestand.

Objectmodel

De volgende klassen en interfaces verwerken enkele van de belangrijkste functies van de Azure Communication Services SMS SDK voor Node.js.

Naam	Beschrijving
SmsClient	Deze klasse is vereist voor alle sms-functionaliteit. U instantieert deze klasse met uw abonnementsgegevens en gebruikt deze om sms-berichten te verzenden.
SmsSendRequest	Deze interface is het model voor het bouwen van de sms-aanvraag (bijvoorbeeld: configureer de telefoonnummers van de afzender en ontvanger en de sms-inhoud).
SmsSendOptions	Deze interface biedt opties voor het configureren van leveringsrapporten. Als enableDeliveryReport is ingesteld op , wordt er een gebeurtenis uitgezonden wanneer de levering is true geslaagd.
SmsSendResult	Deze klasse bevat het resultaat van de SMS-service.

De client verifiëren

Importeer de SmsClient uit de SDK en instantieer deze met uw connection string. Met de onderstaande code wordt de verbindingsreeks voor de resource opgehaald uit een omgevingsvariabele met de naam COMMUNICATION_SERVICES_CONNECTION_STRING. Meer informatie over het beheren van de connection string.

Maak een bestand met de naam send-sms.js en voeg de volgende code toe:

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);

Een 1:N sms-bericht verzenden

Als u een sms-bericht wilt verzenden naar een lijst met ontvangers, roept u de functie aan vanuit de SmsClient met een lijst met telefoonnummers van ontvangers (als u een bericht naar één ontvanger wilt verzenden, moet u slechts één nummer in de lijst send opnemen). Voeg deze code toe aan het einde vansend-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();

Vervang door een telefoonnummer met sms-functie dat is gekoppeld aan uw Communication Services-resource en door de telefoonnummers waar u een bericht naar <from-phone-number> <to-phone-number-1> wilt <to-phone-number-2> verzenden.

Een 1:N sms-bericht met opties verzenden

U kunt ook een optiesobject doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen.

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();

Vervang door een telefoonnummer met sms-functie dat is gekoppeld aan uw Communication Services-resource en door een of meer telefoonnummers waar u een bericht <from-phone-number> <to-phone-number-1> naar wilt <to-phone-number-2> verzenden.

De parameter enableDeliveryReport is een optionele parameter die u kunt gebruiken voor het configureren van leveringsrapporten. Dit is handig voor scenario's waarin u gebeurtenissen wilt verzenden wanneer sms-berichten worden bezorgd. Raadpleeg de quickstart Sms-gebeurtenissen verwerken voor het configureren van leveringsrapporten voor uw sms-berichten. tag is een optionele parameter die u kunt gebruiken om een tag toe te passen op het leveringsrapport.

De code uitvoeren

Gebruik de opdracht node om de code uit te voeren die u aan het bestand send-sms.js hebt toegevoegd.

node ./send-sms.js

Ga aan de slag Azure Communication Services met behulp van Communication Services Python SMS SDK om sms-berichten te verzenden.

Voor het voltooien van deze quickstart worden kosten van een paar dollarcent of minder in rekening gebracht bij uw Azure-account.

Vereisten

• Een Azure-account met een actief abonnement. Gratis een account maken
• Python 2.7 of 3.6+.
• Een actieve Communication Services-resource en verbindingsreeks. Een Communication Services-resource maken.
• Een telefoonnummer met sms-functionaliteit. Een telefoonnummer aanvragen.

Controle van vereisten

• Voer in een terminal- of opdrachtvenster de opdracht python --version uit om te controleren of Python is geïnstalleerd.
• Als u de telefoonnummers wilt weergeven die zijn gekoppeld aan uw Communication Services-resource, meldt u zich aan bij Azure Portal, zoekt u uw Communication Services-resource en opent u het tabblad telefoonnummers vanuit het navigatiedeelvenster aan de linkerkant.

Instellen

Een nieuwe Python-toepassing maken

Open uw terminal of opdrachtvenster, maak een nieuwe map voor uw app en navigeer daar naartoe.

mkdir sms-quickstart && cd sms-quickstart

Gebruik een tekst editor om een bestand te maken met de naam send-sms.py in de hoofdmap van het project en voeg de structuur voor het programma toe, waaronder de basale verwerking van uitzonderingen. In de volgende secties voegt u alle broncode voor deze quickstart toe aan dit bestand.

import os
from azure.communication.sms import SmsClient

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

Het pakket installeren

Terwijl u zich nog in de toepassingsmap blijft, installeert u Azure Communication Services SMS SDK voor Python-pakket met behulp van de pip install opdracht .

pip install azure-communication-sms

Objectmodel

De volgende klassen en interfaces verwerken enkele van de belangrijkste functies van de Azure Communication Services SMS SDK voor Python.

Naam	Beschrijving
SmsClient	Deze klasse is vereist voor alle sms-functionaliteit. U instantieert deze klasse met uw abonnementsgegevens en gebruikt deze om sms-berichten te verzenden.
SmsSendResult	Deze klasse bevat het resultaat van de SMS-service.

De client verifiëren

Breng een SmsClient tot stand met uw verbindingsreeks. Meer informatie over het beheren van de connection string.

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

Voor het gemak gebruiken we verbindingsreeksen in deze quickstart, maar in productieomgevingen raden we u aan om service-principals te gebruiken.

Een 1:1 sms-bericht verzenden

Als u een sms-bericht naar één ontvanger wilt verzenden, roept u de methode vanuit send de SmsClient aan met één telefoonnummer van de ontvanger. U kunt ook optionele parameters doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen. Voeg deze code toe aan het einde van het 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

U moet <from-phone-number> vervangen door een telefoonnummer met sms-functionaliteit dat is gekoppeld aan uw communicatieservice en <to-phone-number> met het telefoonnummer waarnaar u een bericht wilt verzenden.

Een 1:N sms-bericht verzenden

Als u een sms-bericht wilt verzenden naar een lijst met ontvangers, roept u de methode aan vanuit send de SmsClient met een lijst met telefoonnummers van de ontvanger. U kunt ook optionele parameters doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen. Voeg deze code toe aan het einde van het 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

Vervang door een telefoonnummer met sms-nummer dat is gekoppeld aan uw communicatieservice en door een of meer telefoonnummers waar u een bericht <from-phone-number> <to-phone-number-1> <to-phone-number-2> naar wilt verzenden.

Optionele parameters

De parameter enable_delivery_report is een optionele parameter die u kunt gebruiken voor het configureren van leveringsrapporten. Dit is handig voor scenario's waarin u gebeurtenissen wilt verzenden wanneer sms-berichten worden bezorgd. Raadpleeg de quickstart Sms-gebeurtenissen verwerken voor het configureren van leveringsrapporten voor uw sms-berichten.

De tag parameter is een optionele parameter die u kunt gebruiken om een tag toe te passen op het Leveringsrapport.

De code uitvoeren

Voer de toepassing op vanuit uw toepassingsmap met de opdracht python.

python send-sms.py

Het volledige Python-script moet er als de volgende uitzien:

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)

Ga aan de slag met Azure Communication Services met behulp van Communication Services Java SMS SDK voor het verzenden van sms-berichten.

Voor het voltooien van deze quickstart worden kosten van een paar dollarcent of minder in rekening gebracht bij uw Azure-account.

Vereisten

• Een Azure-account met een actief abonnement. Gratis een account maken
• Java Development Kit (JDK) versie 8 of hoger.
• Apache Maven.
• Een actieve Communication Services-resource en verbindingsreeks. Een Communication Services-resource maken.
• Een telefoonnummer met sms-functionaliteit. Een telefoonnummer aanvragen.

Controle van vereisten

• Voer mvn -v in een terminal of opdrachtvenster uit om te controleren of maven is geïnstalleerd.
• Als u de telefoonnummers wilt weergeven die zijn gekoppeld aan uw Communication Services-resource, meldt u zich aan bij Azure Portal, zoekt u uw Communication Services-resource en opent u het tabblad telefoonnummers vanuit het navigatiedeelvenster aan de linkerkant.

Instellen

Een nieuwe Java-toepassing maken

Open uw terminal- of opdrachtvenster en navigeer naar de map waarin u uw Java-toepassing wilt maken. Voer de onderstaande opdracht uit om het Java-project te genereren op basis van de maven-archetype-snelstart-sjabloon.

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

Het doel 'genereren' zal een map maken met dezelfde naam als de artifactId. De map src/main/java bevat de broncode van het project, de map src/test/java bevat de testbron en het bestand pom.xml is het Project Object Model van het project of POM.

Het pakket installeren

Open het bestand pom.xml in uw teksteditor. Voeg het volgende afhankelijkheidselement toe aan de groep met afhankelijkheden.

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

Het app-framework instellen

Open /src/main/java/com/communication/quickstart/App.java in een teksteditor, voeg importregels toe en verwijder de instructie System.out.println("Hello world!");:

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
    }
}

Objectmodel

De volgende klassen en interfaces verwerken enkele van de belangrijkste functies van de Azure Communication Services SMS SDK voor Java.

Naam	Beschrijving
SmsClientBuilder	Deze klasse maakt de SmsClient. U geeft een eindpunt, referentie en een HTTP-client op.
SmsClient	Deze klasse is vereist voor alle sms-functionaliteit. U kunt deze gebruiken om sms-berichten te verzenden.
SmsSendOptions	Deze klasse biedt opties om aangepaste tags toe te voegen en leveringsrapportage te configureren. Als deliveryReportEnabled is ingesteld op true, wordt er een gebeurtenis uitgezonden wanneer de levering is geslaagd
SmsSendResult	Deze klasse bevat het resultaat van de SMS-service.

De client verifiëren

Breng een SmsClient tot stand met uw verbindingsreeks. (Referentie is de Key van de Azure Portal. Meer informatie over het beheren van de connection string. Bovendien kunt u de client initialiseren met elke aangepaste HTTP-client die de com.azure.core.http.HttpClient interface implementeert.

Voeg de volgende code aan de main methode toe:

// 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();

U kunt ook de volledige verbindingsreeks opgeven met behulp van de functie connectionString() in plaats van het eindpunt en de toegangssleutel op te geven.

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

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

Een 1:1 sms-bericht verzenden

Als u een sms-bericht naar één ontvanger wilt verzenden, roept u de methode aan vanuit send de SmsClient met één telefoonnummer voor de ontvanger. U kunt ook optionele parameters doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen.

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());

Vervang door een telefoonnummer met sms-functie dat is gekoppeld aan uw Communication Services-resource en door een telefoonnummer waar u een bericht <from-phone-number> <to-phone-number> naar wilt verzenden.

Een 1:N sms-bericht met opties verzenden

Als u een sms-bericht wilt verzenden naar een lijst met ontvangers, roept u de methode send aan met een lijst met telefoonnummers van ontvangers. U kunt ook optionele parameters doorgeven om op te geven of het leveringsrapport moet worden ingeschakeld en om aangepaste tags in te stellen.

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());
}

Vervang door een telefoonnummer met sms-functie dat is gekoppeld aan uw Communication Services-resource en door een of meer telefoonnummers waar u een bericht <from-phone-number> <to-phone-number-1> naar wilt <to-phone-number-2> verzenden.

De setDeliveryReportEnabled methode wordt gebruikt om Leveringsrapportage te configureren. Dit is handig voor scenario's waarin u gebeurtenissen wilt verzenden wanneer sms-berichten worden bezorgd. Raadpleeg de quickstart Sms-gebeurtenissen verwerken voor het configureren van leveringsrapporten voor uw sms-berichten.

De setTag methode wordt gebruikt om een tag toe te passen op het leveringsrapport.

De code uitvoeren

Navigeer naar de map die het bestand pom.xml bevat en compileer het project met de opdracht mvn.

mvn compile

Bouw vervolgens het pakket.

mvn package

Voer de volgende mvn-opdracht uit om de app uit te voeren.

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