Megosztás a következőn keresztül:

Azure Communication SMS-ügyfélkódtár JavaScripthez – 1.1.0-s verzió

  • Cikk

Az Azure Communication SMS-szolgáltatások lehetővé teszi a fejlesztők számára, hogy SMS-üzeneteket küldjenek a Communication Servicesen keresztül megvásárolható telefonszámról.

Első lépések

Előfeltételek

Telepítés

npm install @azure/communication-sms

Telefonszám beszerzése

Telefonszámokat az Azure Portalon szerezhet be és rendelhet hozzá egy Communication Services-erőforráshoz. Itt talál útmutatást a telefonszámok Azure Portal használatával történő lekéréséhez.

A csomag használatával @azure/communication-phone-numbers telefonszámot is kaphat. A csomag használatára vonatkozó útmutatás a csomag README-jében található.

Böngészőtámogatás

JavaScript-csomag

Ahhoz, hogy ezt az ügyfélkódtárat a böngészőben használhassa, először egy kötegelőt kell használnia. Ennek részleteiért tekintse meg a csomagküldő dokumentációt.

Fő fogalmak

SmsClient

SmsClient az ügyfélkódtárat használó fejlesztők elsődleges felülete. Aszinkron metódust biztosít AZ SMS-üzenetek küldéséhez.

Példák

Hitelesítés

Kulcs és/vagy kapcsolati karakterlánc a Communication Services-erőforrásból az Azure Portalon szerezheti be. Miután rendelkezik egy kulccsal, az alábbi módszerek bármelyikével hitelesítheti magát:

Kapcsolati karakterlánc használata

import { SmsClient } from "@azure/communication-sms";

const connectionString = `endpoint=https://<resource-name>.communication.azure.com/;accessKey=<Base64-Encoded-Key>`;
const client = new SmsClient(connectionString);

Hitelesítő adatok létrehozása a paranccsal AzureKeyCredential

import { AzureKeyCredential } from "@azure/core-auth";
import { SmsClient } from "@azure/communication-sms";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new AzureKeyCredential("<Base64-Encoded-Key>");
const client = new SmsClient(endpoint, credential);

Felügyelt Azure Active Directory-identitás használata

A legtöbb példában ügyfél API-kulcshitelesítést használnak, de az Azure Identity-kódtár használatával az Azure Active Directoryval is hitelesíthetők. Az alább látható DefaultAzureCredential szolgáltató vagy az Azure SDK-hoz biztosított egyéb hitelesítőadat-szolgáltatók használatához telepítse a @azure/identity csomagot:

npm install @azure/identity

A @azure/identity csomag számos hitelesítőadat-típust biztosít, amelyeket az alkalmazás használhat erre. A README további @azure/identity részleteket és mintákat biztosít az első lépésekhez. AZURE_CLIENT_SECRET, AZURE_CLIENT_ID és AZURE_TENANT_ID környezeti változók szükségesek a DefaultAzureCredential objektum létrehozásához.

import { DefaultAzureCredential } from "@azure/identity";
import { SmsClient } from "@azure/communication-sms";

const endpoint = "https://<resource-name>.communication.azure.com";
let credential = new DefaultAzureCredential();
const client = new SmsClient(endpoint, credential);

1:N SMS-üzenet küldése

SMS-üzenet küldéséhez hívja meg a függvényt a sendSmsClientkövetkezőből: . Át kell adnia egy SmsSendRequest objektumot. Megadhat egy továbbítási objektumot is, amely megadja, hogy engedélyezve legyen-e a kézbesítési jelentés, és egyéni címkéket állítson be a jelentéshez. A függvény egy tömböt SmsSendResult ad vissza. A successful rendszer jelölővel ellenőrzi, hogy az egyes üzenetek elküldése sikeres volt-e.

const sendResults = await client.send(
  {
    from: "<from-phone-number>", // Your E.164 formatted phone number used to send SMS
    to: ["<to-phone-number-1>", "<to-phone-number-2>"], // The list of E.164 formatted phone numbers to which message is being sent
    message: "Weekly Promotion!" // The message being sent
  },
  {
    enableDeliveryReport: true,
    tag: "marketing"
  }
);

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

Hibaelhárítás

Az SMS-műveletek kivételt jeleznek, ha a kiszolgálóra irányuló kérés meghiúsul. A rendszer nem ad kivételeket, ha a hibát egy egyéni üzenet okozza, csak akkor, ha valami meghiúsul az általános kéréssel. Az egyes eredmények ellenőrzéséhez használja a successful jelzőt, hogy ellenőrizze, hogy az üzenet elküldve lett-e.

try {
  const sendResults = await client.send({
    from: "<from-phone-number>", // Your E.164 formatted phone number used to send SMS
    to: ["<to-phone-number-1>", "<to-phone-number-2>"], // The list of E.164 formatted phone numbers to which message is being sent
    message: "Hello World via SMS!" // The message being sent
  });
  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);
    }
  }
} catch (e) {
  console.error(e.message);
}

Következő lépések

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót , amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

Megjelenések