Rychlý Start: odeslání zprávy SMS

Začínáme s komunikačními službami Azure pomocí služby Communications Services C# SMS SDK k posílání zpráv SMS.

Po dokončení tohoto rychlého startu dojde v účtu Azure k malým nákladům na několik centů nebo méně.

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si účet zdarma.
• Nejnovější verze .NET Core SDK pro váš operační systém.
• Aktivní prostředek komunikační služby a připojovací řetězec. Vytvořte prostředek služby Communications.
• Telefonní číslo s povoleným SMS. Získejte telefonní číslo.

Kontrola požadovaných součástí

• V terminálu nebo příkazovém okně spusťte dotnet příkaz a ověřte, zda je nainstalována sada .NET SDK.
• Chcete-li zobrazit telefonní čísla přidružená ke zdroji komunikačních služeb, přihlaste se k Azure Portal, vyhledejte prostředek komunikačních služeb a otevřete kartu telefonní čísla v levém navigačním podokně.

Nastavení

Vytvoření nové aplikace v C#

V okně konzoly (například cmd, PowerShell nebo bash) použijte dotnet new příkaz k vytvoření nové aplikace konzoly s názvem SmsQuickstart . Tento příkaz vytvoří jednoduchý projekt C# "Hello World" s jedním zdrojovým souborem: program. cs.

dotnet new console -o SmsQuickstart

Změňte adresář na nově vytvořenou složku aplikace a použijte dotnet build příkaz pro zkompilování aplikace.

cd SmsQuickstart
dotnet build

Instalace balíčku

Stále v adresáři aplikace nainstalujte pomocí příkazu balíček služby SMS SDK pro službu Azure Communications Services pro .NET dotnet add package .

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

Přidejte do using horní části programu. cs direktivu, aby zahrnovala Azure.Communication obor názvů.

using System;
using System.Collections.Generic;

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

Objektový model

Následující třídy a rozhraní zpracovávají některé hlavní funkce služby Azure Communications Services SMS SDK pro jazyk C#.

Název	Popis
SmsClient	Tato třída je potřebná pro všechny funkce SMS. Vytvoří se jeho instance s informacemi o předplatném a použije se k posílání zpráv SMS.
SmsSendOptions	Tato třída poskytuje možnosti konfigurace vytváření sestav o doručení. Pokud je enable_delivery_report nastavené na hodnotu true, vygeneruje se po úspěšném doručení událost.
SmsSendResult	Tato třída obsahuje výsledek ze služby SMS.

Ověření klienta

V textovém editoru otevřete program program. cs a nahraďte tělo Main metody kódem pro inicializaci SmsClient pomocí připojovacího řetězce. Následující kód načte připojovací řetězec pro prostředek z proměnné prostředí s názvem COMMUNICATION_SERVICES_CONNECTION_STRING . Naučte se Spravovat připojovací řetězec prostředku.

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

Poslat zprávu SMS 1:1

Chcete-li odeslat zprávu SMS jednomu příjemci, zavolejte Send SendAsync funkci nebo z SmsClient. Přidejte tento kód na konec Main metody v programu 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}");

Měli byste nahradit <from-phone-number> telefonním číslem s povoleným serverem SMS přidruženým k vašemu prostředku komunikačních služeb a <to-phone-number> telefonním číslem, na které chcete poslat zprávu.

Odeslat zprávu o 1: N SMS s možnostmi

Chcete-li odeslat zprávu SMS seznamu příjemců, zavolejte Send SendAsync funkci or ze SmsClient se seznamem telefonních čísel příjemců. K určení, zda má být povolena zpráva o doručení a nastavena vlastní značky, můžete také předat volitelné parametry.

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

Měli byste nahradit <from-phone-number> telefonním číslem s podporou serveru SMS, který je přidružený k vašemu prostředku komunikačních služeb, a <to-phone-number-1> <to-phone-number-2> s telefonními čísly, na které chcete poslat zprávu.

enableDeliveryReportParametr je volitelný parametr, který můžete použít ke konfiguraci vytváření sestav o doručení. To je užitečné ve scénářích, kdy chcete generovat události při doručování zpráv SMS. Nastavování sestav doručení pro zprávy SMS najdete v rychlém startu pro zpracování událostí SMS .

Tag slouží k použití značky pro sestavu doručení.

Spuštění kódu

Spusťte aplikaci z adresáře aplikace pomocí dotnet run příkazu.

dotnet run

Příklad kódu

Ukázkovou aplikaci si můžete stáhnout z GitHub

Začínáme s odesíláním Azure Communication Services zpráv SMS pomocí Communication Services JavaScript SMS SDK.

Za dokončení tohoto rychlého startu se ve vašem účtu Azure účtu Azure účtu vynačítá náklady na pár centů USD nebo méně.

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si účet zdarma.
• Node.js Verze Active LTS a Maintenance LTS (doporučuje se verze 8.11.1 a 10.14.1).
• Aktivní prostředek Communication Services připojovací řetězec. Vytvořte prostředek Communication Services .
• Telefonní číslo s povolenou zprávou SMS. Získejte telefonní číslo.

Kontrola předpokladů

• V terminálu nebo v příkazovém okně spusťte příkaz a node --version zkontrolujte, Node.js je nainstalovaná.
• Pokud chcete zobrazit telefonní čísla přidružená k vašemu prostředku Communication Services, přihlaste se k Azure Portal , vyhledejte prostředek Communication Services a v levém navigačním podokně otevřete kartu telefonních čísel.

Nastavení

Vytvoření nové Node.js aplikace

Nejprve otevřete terminál nebo příkazové okno, vytvořte nový adresář pro vaši aplikaci a přejděte do něj.

mkdir sms-quickstart && cd sms-quickstart

Spuštěním npm init -y vytvořte soubor package.json s výchozím nastavením.

npm init -y

Pomocí textového editoru vytvořte soubor s názvem send-sms.js v kořenovém adresáři projektu. Do tohoto souboru v následujících částech přidáte veškerý zdrojový kód pro tento rychlý start.

Instalace balíčku

Pomocí příkazu npm install nainstalujte sadu SDK Azure Communication Services SMS pro JavaScript.

npm install @azure/communication-sms --save

Možnost --save vypíše knihovnu jako závislost v souboru package.json.

Objektový model

Následující třídy a rozhraní se řídí některými hlavními funkcemi sady AZURE COMMUNICATION SERVICES SMS SDK pro Node.js.

Název	Popis
SmsClient	Tato třída je potřebná pro všechny funkce SMS. Vytvoříte instanci s informacemi o předplatném a použijete ji k odesílání zpráv SMS.
SmsSendRequest	Toto rozhraní je model pro sestavení požadavku SMS (např. nakonfigurujte na telefonní čísla a z telefonních čísel a obsah SMS).
SmsSendOptions	Toto rozhraní poskytuje možnosti konfigurace generování sestav doručení. Pokud je nastavena na , po úspěšném doručení se enableDeliveryReport vysílá true událost.
SmsSendResult	Tato třída obsahuje výsledek ze služby SMS.

Ověření klienta

Importujte SmsClient ze sady SDK a vytvořte instanci pomocí připojovacího řetězce. Následující kód načte připojovací řetězec pro prostředek z proměnné prostředí s názvem COMMUNICATION_SERVICES_CONNECTION_STRING . Zjistěte, jak spravovat připojovací řetězec vašeho prostředku.

Vytvořte a otevřete soubor s názvem send-sms.js a přidejte následující kód:

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

Odeslání zprávy SMS 1:N

Pokud chcete odeslat zprávu SMS do seznamu příjemců, zavolejte funkci z klienta SmsClient se seznamem telefonních čísel příjemců (pokud chcete odeslat zprávu jednomu příjemci, používejte v seznamu jenom jedno send číslo). Na konec souboru přidejte tentosend-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();

Měli byste nahradit telefonním číslem s povolenou SMS, které je přidružené k vašemu prostředku Communication Services, a za telefonní čísla, na která chcete <from-phone-number> <to-phone-number-1> odeslat <to-phone-number-2> zprávu.

Odeslání zprávy SMS 1:N s možnostmi

Můžete také předat objekt options a určit, jestli se má povolit sestava doručení, a nastavit vlastní značky.

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

Měli byste nahradit telefonním číslem s povolenou SMS, které je přidružené k vašemu prostředku Communication Services, a telefonními čísly, na která <from-phone-number> <to-phone-number-1> chcete odeslat <to-phone-number-2> zprávu.

Parametr enableDeliveryReport je volitelný parametr, který můžete použít ke konfiguraci delivery reportingu. To je užitečné ve scénářích, kdy chcete generovat události při doručení zpráv SMS. Informace o konfiguraci zasílání zpráv SMS najdete v rychlém startu Zpracování událostí SMS. tag je volitelný parametr, který můžete použít k použití značky na sestavu doručení.

Spuštění kódu

Pomocí příkazu node spusťte kód, který jste přidali do send-sms.js souboru.

node ./send-sms.js

Začněte s komunikačními službami Azure pomocí komunikačních služeb Python SDK pro posílání zpráv SMS.

Po dokončení tohoto rychlého startu dojde v účtu Azure k malým nákladům na několik centů nebo méně.

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si účet zdarma.
• Python 2,7 nebo 3.6 +.
• Aktivní prostředek komunikační služby a připojovací řetězec. Vytvořte prostředek služby Communications.
• Telefonní číslo s povoleným SMS. Získejte telefonní číslo.

Kontrola požadovaných součástí

• V okně terminálu nebo příkazu spusťte python --version příkaz a ověřte, zda je Python nainstalován.
• Chcete-li zobrazit telefonní čísla přidružená ke zdroji komunikačních služeb, přihlaste se k Azure Portal, vyhledejte prostředek komunikačních služeb a otevřete kartu telefonní čísla v levém navigačním podokně.

Nastavení

Vytvoření nové aplikace v Pythonu

Otevřete okno terminálu nebo příkaz, pro svou aplikaci vytvořte nový adresář a přejděte do něj.

mkdir sms-quickstart && cd sms-quickstart

Pomocí textového editoru vytvořte soubor s názvem Send-SMS.py v kořenovém adresáři projektu a přidejte strukturu pro program, včetně základního zpracování výjimek. Do tohoto souboru přidáte veškerý zdrojový kód pro tento rychlý Start v následujících oddílech.

import os
from azure.communication.sms import SmsClient

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

Instalace balíčku

Ještě pořád v adresáři aplikace nainstalujte balíček Azure Communications Services SMS SDK pro Python pomocí pip install příkazu.

pip install azure-communication-sms

Objektový model

Následující třídy a rozhraní zpracovávají některé hlavní funkce sady SDK služby Azure Communications Services pro Python.

Název	Popis
SmsClient	Tato třída je potřebná pro všechny funkce SMS. Vytvoří se jeho instance s informacemi o předplatném a použije se k posílání zpráv SMS.
SmsSendResult	Tato třída obsahuje výsledek ze služby SMS.

Ověření klienta

Vytvořte instanci SmsClient s připojovacím řetězcem. Naučte se Spravovat připojovací řetězec prostředku.

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

Pro zjednodušení používáme připojovací řetězce v tomto rychlém startu, ale v produkčních prostředích doporučujeme používat instanční objekty.

Poslat zprávu SMS 1:1

Chcete-li odeslat zprávu SMS jednomu příjemci, zavolejte send metodu z SmsClient s jedním příjemcem telefonního čísla. K určení, zda má být povolena zpráva o doručení a nastavena vlastní značky, můžete také předat volitelné parametry. Přidejte tento kód na konec try bloku v 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

Měli byste nahradit <from-phone-number> telefonním číslem s povoleným serverem SMS přidruženým ke komunikační službě a <to-phone-number> telefonním číslem, na které chcete poslat zprávu.

Odeslat zprávu o 1: N SMS

Chcete-li odeslat zprávu SMS seznamu příjemců, zavolejte send metodu ze SmsClient se seznamem telefonních čísel příjemců. K určení, zda má být povolena zpráva o doručení a nastavena vlastní značky, můžete také předat volitelné parametry. Přidejte tento kód na konec try bloku v 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

Měli byste nahradit <from-phone-number> telefonním číslem s povoleným serverem SMS přidruženým ke komunikační službě a <to-phone-number-1> <to-phone-number-2> telefonními čísly, na které chcete poslat zprávu.

Volitelné parametry

enable_delivery_reportParametr je volitelný parametr, který můžete použít ke konfiguraci vytváření sestav o doručení. To je užitečné ve scénářích, kdy chcete generovat události při doručování zpráv SMS. Nastavování sestav doručení pro zprávy SMS najdete v rychlém startu pro zpracování událostí SMS .

tagParametr je volitelný parametr, který můžete použít k použití značky pro sestavu doručení.

Spuštění kódu

Spusťte aplikaci z adresáře aplikace pomocí python příkazu.

python send-sms.py

Kompletní skript Pythonu by měl vypadat nějak takto:

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)

Začínáme s odesíláním Azure Communication Services sms pomocí Communication Services Java SMS SDK.

Za dokončení tohoto rychlého startu se ve vašem účtu Azure účtu Azure účtu vynačítá náklady na pár centů USD nebo méně.

Požadavky

• Účet Azure s aktivním předplatným. Vytvořte si účet zdarma.
• Java Development Kit (JDK) verze 8 nebo vyšší.
• Apache Maven.
• Aktivní prostředek Communication Services připojovací řetězec. Vytvořte prostředek Communication Services .
• Telefonní číslo s povolenou zprávou SMS. Získejte telefonní číslo.

Kontrola předpokladů

• V terminálu nebo v příkazovém okně spusťte a mvn -v zkontrolujte, že je maven nainstalovaný.
• Pokud chcete zobrazit telefonní čísla přidružená k vašemu prostředku Communication Services, přihlaste se k Azure Portal , vyhledejte prostředek Communication Services a v levém navigačním podokně otevřete kartu telefonních čísel.

Nastavení

Vytvoření nové aplikace v Javě

Otevřete terminál nebo příkazové okno a přejděte do adresáře, ve kterém chcete vytvořit svou aplikaci v Javě. Spuštěním následujícího příkazu vygenerujte projekt Java ze šablony maven-archetype-quickstart.

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

Cíl generování vytvoří adresář se stejným názvem jako artifactId. V tomto adresáři obsahuje adresář src/main/java zdrojový kód projektu, adresář src/test/java obsahuje zdroj testu a souborpom.xml je objektový model Project projektu nebo pom.

Instalace balíčku

Otevřete soubor pom.xml v textovém editoru. Přidejte následující element závislosti do skupiny závislostí.

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

Nastavení architektury aplikace

Otevřete /src/main/java/com/communication/quickstart/App.java v textovém editoru, přidejte direktivy importu a odeberte System.out.println("Hello world!"); příkaz :

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

Objektový model

Následující třídy a rozhraní se řídí některými hlavními funkcemi sady AZURE COMMUNICATION SERVICES SMS SDK pro Javu.

Název	Popis
SmsClientBuilder	Tato třída vytvoří SmsClient. Poskytnete jim koncový bod, přihlašovací údaje a klienta HTTP.
SmsClient	Tato třída je potřebná pro všechny funkce SMS. Použijete ho k odesílání zpráv SMS.
SmsSendOptions	Tato třída poskytuje možnosti pro přidání vlastních značek a konfiguraci generování sestav doručení. Pokud je vlastnost deliveryReportEnabled nastavená na hodnotu true, při úspěšném doručení se vysílá událost.
SmsSendResult	Tato třída obsahuje výsledek ze služby SMS.

Ověření klienta

Vytvořte instanci s SmsClient vaším připojovacím řetězcem. (Přihlašovací údaje jsou Key z Azure Portal. Zjistěte, jak spravovat připojovací řetězec vašeho prostředku. Kromě toho můžete klienta inicializovat pomocí libovolného vlastního klienta HTTP, který implementuje com.azure.core.http.HttpClient rozhraní .

Do metody main přidejte následující kód:

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

Můžete také zadat celý připojovací řetězec pomocí funkce connectionString() místo poskytnutí koncového bodu a přístupového klíče.

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

Odeslání zprávy SMS 1:1

Pokud chcete odeslat zprávu SMS jednomu příjemci, zavolejte metodu z send SmsClient s jedním telefonním číslem příjemce. Můžete také předat volitelné parametry, které určují, jestli se má sestava doručení povolit, a nastavit vlastní značky.

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

Měli byste nahradit telefonním číslem s povolenou zprávou SMS přidruženým k vašemu prostředku Communication Services a telefonním číslem, na které <from-phone-number> <to-phone-number> chcete odeslat zprávu.

Odeslání zprávy SMS 1:N s možnostmi

Pokud chcete odeslat zprávu SMS seznamu příjemců, zavolejte metodu send se seznamem telefonních čísel příjemců. Můžete také předat volitelné parametry, které určují, jestli se má sestava doručení povolit, a nastavit vlastní značky.

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

Měli byste nahradit telefonním číslem s povolenou zprávou SMS přidruženým k vašemu prostředku Communication Services a telefonními čísly, na která <from-phone-number> <to-phone-number-1> chcete odeslat <to-phone-number-2> zprávu.

Metoda setDeliveryReportEnabled se používá ke konfiguraci generování sestav doručení. To je užitečné ve scénářích, kdy chcete generovat události při doručení zpráv SMS. Informace o konfiguraci zasílání zpráv SMS najdete v rychlém startu Zpracování událostí SMS.

Metoda setTag se používá k použití značky na sestavu doručení.

Spuštění kódu

Přejděte do adresáře obsahujícího pom.xml a zkompilujte projekt pomocí mvn příkazu .

mvn compile

Pak sestavte balíček .

mvn package

Spusťte aplikaci mvn spuštěním následujícího příkazu.

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