共用方式為

快速入門：使用進階訊息傳送 WhatsApp 訊息

  • 發行項

Azure 通訊服務可讓您傳送和接收 WhatsApp 訊息。 在本快速入門中，開始整合您的應用程式與 Azure 通訊進階訊息 SDK，並開始傳送/接收 WhatsApp 訊息。 完成本快速入門後，您的 Azure 帳戶中會產生幾美分或更少的少許費用。

必要條件

設定

建立 .NET 專案

若要建立專案，請遵循使用 Visual Studio 建立 .NET 主控台應用程式的教學課程。

若要編譯程式碼，請按 Ctrl+F7。

Install the package

將 Azure.Communication.Messages NuGet 套件安裝至 C# 專案。

  1. 在 Project>Manage NuGet Packages... 開啟 NuGet 套件管理員。
  2. 搜尋套件 Azure.Communication.Messages。
  3. 安裝最新版本。

設定應用程式架構

在文字編輯器中開啟 Program.cs 檔案。

將 Program.cs 的內容取代為下列程式碼：

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Communication.Messages;

namespace AdvancedMessagingQuickstart
{
    class Program
    {
        public static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Send WhatsApp Messages");

            // Quickstart code goes here
        }
    }
}

為了使用進階傳訊功能，我們新增 using 指示詞，以包含 Azure.Communication.Messages 命名空間。

using Azure.Communication.Messages;

物件模型

下列類別和介面會處理適用於 .NET 的 Azure 通訊服務進階傳訊 SDK 的一些主要功能。

名稱 描述
NotificationMessagesClient 此類別會連線至您的 Azure 通訊服務資源。 它會傳送訊息。
MessageTemplate 此類別會定義您使用的範本，以及訊息範本屬性的內容。
TemplateNotificationContent 此類別會定義您要傳送之範本訊息的「對象」和「內容」。
TextNotificationContent 此類別會定義您要傳送之文字訊息的「對象」和「內容」。
MediaNotificationContent 此類別會定義您要傳送之媒體訊息的「對象」和「內容」。

程式碼範例

請遵循下列步驟，將必要的程式碼片段新增至 Program.cs 檔案的 Main 函式。

驗證用戶端

NotificationMessagesClient 是用來連線至您的 Azure 通訊服務資源。

為了簡單起見，本快速入門會使用連接字串進行驗證。 在實際執行環境中，我們建議服務主體。

在 Azure 入口網站中從 Azure 通訊服務資源取得連接字串。 在左側瀏覽至 Keys 索引標籤。複製主索引鍵的 Connection string 欄位。 連接字串格式如下：endpoint=https://{your Azure Communication Services resource name}.communication.azure.com/;accesskey={secret key}。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [主索引鍵] 區段中的 [連接字串] 欄位。

將環境變數 COMMUNICATION_SERVICES_CONNECTION_STRING 設定為連接字串的值。
開啟主控台視窗並輸入下列命令：

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例前重新啟動 Visual Studio。

如需如何為系統設定環境變數的詳細資訊，請遵循將連接字串儲存在環境變數中的步驟。

若要具現化 NotificationMessagesClient，請將下列程式碼新增至 Main 方法：

// Retrieve connection string from environment variable
string connectionString = 
    Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");

// Instantiate the client
var notificationMessagesClient = new NotificationMessagesClient(connectionString);

設定頻道註冊識別碼

頻道註冊識別碼 GUID 是在頻道註冊期間建立。 您可以在入口網站中的 Azure 通訊服務資源 [頻道] 索引標籤上查閱。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [頻道] 索引標籤。重點在 [頻道識別碼] 欄位的複製動作上。

將其指派給名為 channelRegistrationId 的變數。

var channelRegistrationId = new Guid("<your channel registration ID GUID>");

設定收件者清單

您必須提供與 WhatsApp 帳戶相關聯的真實電話號碼。 此 WhatsApp 帳戶會接收本快速入門中傳送的範本、文字和媒體訊息。 針對本快速入門，此電話號碼可能是您的個人電話號碼。

收件者電話號碼不能是與 WhatsApp 頻道註冊相關聯的商務電話號碼 (傳送者識別碼)。 傳送者識別碼會顯示為傳送給收件者之文字和媒體訊息的傳送者。

電話號碼應包含國碼 (地區碼)。 如需電話號碼格式的詳細資訊，請參閱 whatsApp 文件中的電話號碼格式。

注意

收件者清單中目前僅支援一個電話號碼。

建立如下的收件者清單：

var recipientList = new List<string> { "<to WhatsApp phone number>" };

範例：

// Example only
var recipientList = new List<string> { "+14255550199" };

開始在企業與 WhatsApp 使用者之間傳送訊息

WhatsApp Business 帳戶與 WhatsApp 使用者之間的交談可以透過下列兩種方式來開始：

  • 企業將範本訊息傳送給 WhatsApp 使用者。
  • WhatsApp 使用者將任何訊息傳送給企業號碼。

不論交談如何開始，企業只能傳送範本訊息，直到使用者傳送訊息給企業為止。只有在使用者傳送訊息給企業之後，企業才能在作用中交談期間將文字或媒體訊息傳送給使用者。 一旦 24 小時交談視窗過期，就必須重新開始交談。 若要深入了解交談，請參閱 WhatsApp Business Platform 中的定義。

(選項 1) 從企業起始交談 - 傳送範本訊息

藉由傳送範本訊息來起始交談。

首先，使用範本的值建立 MessageTemplate。

注意

若要檢查可用的範本，請參閱清單範本中的指示。 如果您沒有可使用的範本，請繼續選項 2。

以下是使用預設範本 sample_template 建立的 MessageTemplate。
如果 sample_template 無法使用，請跳至選項 2。 若是進階使用者，請參閱範本頁面，以了解如何使用選項 1 傳送不同的範本。

訊息 SDK 可讓 Contoso 將範本 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送範本訊息，您需要：

// Assemble the template content
string templateName = "sample_template";
string templateLanguage = "en_us";
var messageTemplate = new MessageTemplate(templateName, templateLanguage);

如需如何組合 MessageTemplate 以及如何建立您自己範本的更多範例，請參閱下列資源：

如需範本的進一步 WhatsApp 需求，請參閱 WhatsApp Business Platform API 參考：

組合然後傳送範本訊息：

// Assemble template message
var templateContent = 
    new TemplateNotificationContent(channelRegistrationId, recipientList, messageTemplate);

// Send template message
Response<SendMessageResult> sendTemplateMessageResult = 
    await notificationMessagesClient.SendAsync(templateContent);

現在，使用者必須回應範本訊息。 從 WhatsApp 使用者帳戶，回覆從 WhatsApp Business 帳戶接收到的範本訊息。 訊息的內容與此案例無關。

重要

收件者必須回應範本訊息才能起始交談，將文字或媒體訊息傳遞給收件者。

(選項 2) 從使用者起始交談

在 WhatsApp Business 帳戶與 WhatsApp 使用者之間起始交談的另一個選項是讓使用者起始交談。 若要這樣做，請從您的個人 WhatsApp 帳戶，將訊息傳送至您的企業號碼 (傳送者識別碼)。

Web 上檢視的 WhatsApp 交談，其中顯示傳送至 WhatsApp Business 帳戶號碼的使用者訊息。

將文字訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 傳送 WhatsApp 文字訊息，該訊息會起始 WhatsApp 使用者起始的項目。 若要傳送文字訊息，您需要：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

在此範例中，我們會以「感謝您的意見反應。來自通知傳訊 SDK」這段文字\n回覆 WhatsApp 使用者。

組合然後傳送文字訊息：

// Assemble text message
var textContent = 
    new TextNotificationContent(channelRegistrationId, recipientList, "Thanks for your feedback.\n From Notification Messaging SDK");

// Send text message
Response<SendMessageResult> sendTextMessageResult = 
    await notificationMessagesClient.SendAsync(textContent);

將媒體訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將 WhatsApp 媒體訊息傳送給 WhatsApp 使用者。 若要傳送內嵌媒體訊息，您需要：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

重要

從 SDK 1.1.0 版起， MediaNotificationContent 映射即將淘汰。 建議您使用 ImageNotificationContent 來傳送影像，並探索其他媒體類型的特定內容類別，例如 DocumentNotificationContent、 VideoNotificationContent和 AudioNotificationContent。

以下是傳送不同類型的媒體訊息的範例代碼段，包括影像、檔、影片和音訊檔案。

傳送影像內容

組合映像訊息：

var imageLink = new Uri("https://example.com/image.jpg");
var imageNotificationContent = new ImageNotificationContent(channelRegistrationId, recipientList, imageLink)  
{  
    Caption = "Check out this image."  
};

傳送影像訊息：

var imageResponse = await notificationMessagesClient.SendAsync(imageNotificationContent);

傳送檔

組合檔案內容：

var documentLink = new Uri("https://example.com/document.pdf");
var documentNotificationContent = new DocumentNotificationContent(channelRegistrationId, recipientList, documentLink)  
{  
    Caption = "Check out this document.",  
    FileName = "document.pdf"  
};

傳送檔案訊息：

var documentResponse = await notificationMessagesClient.SendAsync(documentNotificationContent);

傳送影片內容

組合影片訊息：

var videoLink = new Uri("https://example.com/video.mp4");
var videoNotificationContent = new VideoNotificationContent(channelRegistrationId, recipientList, videoLink)  
{  
    Caption = "Check out this video."  
};

傳送影片訊息：

var videoResponse = await notificationMessagesClient.SendAsync(videoNotificationContent);

傳送音訊內容

組合音訊訊息：

var audioLink = new Uri("https://example.com/audio.mp3");
var audioNotificationContent = new AudioNotificationContent(channelRegistrationId, recipientList, audioLink);

傳送音訊訊息：

var audioResponse = await notificationMessagesClient.SendAsync(audioNotificationContent);

執行程式碼

建立並執行您的程式。

若要傳送文字或媒體訊息給 WhatsApp 使用者，WhatsApp Business 帳戶與 WhatsApp 使用者之間必須有作用中交談。
如果您沒有作用中交談，為了本快速入門的目的，您應該在傳送範本訊息和傳送文字訊息之間新增等候。 這個新增的延遲可讓您有足夠的時間對使用者的 WhatsApp 帳戶進行回覆。 作為參考，範例程式碼的完整範例會在傳送下一則訊息之前，提示手動使用者輸入。

如果成功，您會在使用者的 WhatsApp 帳戶上收到三則訊息。

  1. 若要編譯程式碼，請按 Ctrl+F7。
  2. 若要在不偵錯的情況下執行程式，請按 Ctrl+F5。

完整範例程式碼

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Azure;
using Azure.Communication.Messages;

namespace AdvancedMessagingQuickstart
{
    class Program
    {
        public static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Send WhatsApp Messages\n");

            string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");
            NotificationMessagesClient notificationMessagesClient = 
                new NotificationMessagesClient(connectionString);

            var channelRegistrationId = new Guid("<Your Channel ID>");
            var recipientList = new List<string> { "<Recipient's WhatsApp Phone Number>" };

            // Send sample template sample_template
            string templateName = "sample_template";
            string templateLanguage = "en_us";
            MessageTemplate sampleTemplate = new MessageTemplate(templateName, templateLanguage);
            TemplateNotificationContent templateContent = 
                new TemplateNotificationContent(channelRegistrationId, recipientList, sampleTemplate);
            Response<SendMessageResult> sendTemplateMessageResult = 
                await notificationMessagesClient.SendAsync(templateContent);

            PrintResult(sendTemplateMessageResult);
            Console.WriteLine("Template message sent.\nWait until the WhatsApp user responds " +
                "to the template message, then press any key to continue.\n");
            Console.ReadKey();

            // Send a text message
            string messageText = "Thanks for your feedback.";
            TextNotificationContent textContent =
                new TextNotificationContent(channelRegistrationId, recipientList, messageText);
            Response<SendMessageResult> sendTextMessageResult =
                await notificationMessagesClient.SendAsync(textContent);

            PrintResult(sendTextMessageResult);
            Console.WriteLine($"Text message sent to my phoneNumber.\nPress any key to continue.\n");
            Console.ReadKey();

            // Send a media message
            Uri uri = new Uri("https://aka.ms/acsicon1");
            ImageNotificationContent imageContent =
                new ImageNotificationContent(channelRegistrationId, recipientList, uri);
            Response<SendMessageResult> sendMediaMessageResult =
                await notificationMessagesClient.SendAsync(imageContent);

            PrintResult(sendMediaMessageResult);
            Console.WriteLine("Media message sent.\nPress any key to exit.\n");
            Console.ReadKey();
        }

        public static void PrintResult(Response<SendMessageResult> result)
        {
            Console.WriteLine($"Response: {result.GetRawResponse().Status} " +
                $"({result.GetRawResponse().ReasonPhrase})");
            Console.WriteLine($"Date: " +
                $"{result.GetRawResponse().Headers.First(header => header.Name == "Date").Value}");
            Console.WriteLine($"ClientRequestId: {result.GetRawResponse().ClientRequestId}");
            Console.WriteLine($"MS-CV: " +
                $"{result.GetRawResponse().Headers.First(header => header.Name == "MS-CV").Value}");
            foreach (var receipts in result.Value.Receipts)
            {
                Console.WriteLine($"MessageId: {receipts.MessageId}");
            }
            Console.WriteLine($"\n");
        }
    }
}

必要條件

設定

若要設定傳送訊息的環境，請執行下列各節中的步驟。

建立新的 Java 應用程式

開啟您的終端機或命令視窗，然後瀏覽至您想要在其中建立 Java 應用程式的目錄。 執行下列命令以從 maven-archetype-quickstart 範本產生 JAVA 專案。

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

generate 目標會建立具有與 artifactId 值相同名稱的目錄。 在此目錄下，src/main/java 目錄包含專案原始程式碼，src/test/java 目錄 包含測試來源，而 pom.xml 檔案是專案的「專案物件模型」(POM)。

Install the package

在文字編輯器中開啟 pom.xml 檔案。 將下列相依性元素加入至相依性群組。

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

設定應用程式架構

在文字編輯器中開啟 /src/main/java/com/communication/quickstart/App.java、新增匯入指示詞，並移除 System.out.println("Hello world!"); 陳述式：

package com.communication.quickstart;

import com.azure.communication.messages.*;
import com.azure.communication.messages.models.*;

import java.util.ArrayList;
import java.util.List;
public class App
{
    public static void main( String[] args )
    {
        // Quickstart code goes here.
    }
}

物件模型

下列類別和介面會處理適用於 Java 的 Azure 通訊服務進階傳訊 SDK 的一些主要功能。

名稱 描述
NotificationMessagesClientBuilder 這個類別會建立通知訊息用戶端。 您可以為其提供端點和認證。
NotificationMessagesClient 需要這個類別才能傳送 WhatsApp 訊息並下載媒體檔案。
NotificationMessagesAsyncClient 需要這個類別才能以非同步方式傳送 WhatsApp 訊息並下載媒體檔案。
SendMessageResult 這個類別包含傳送通知訊息的進階傳訊服務結果。
MessageTemplateClientBuilder 這個類別會建立訊息範本用戶端。 您可以為其提供端點和認證。
MessageTemplateClient 需要這個類別才能取得 WhatsApp 範本的清單。
MessageTemplateAsyncClient 需要這個類別才能以非同步的方式取得 WhatsApp 範本的清單。

程式碼範例

請遵循下列步驟，將必要的程式碼片段新增至 App.java 檔案的 Main 函式。

驗證用戶端

有一些不同的選項可用來驗證訊息用戶端：

若要驗證用戶端，您可以使用連接字串具現化 NotificationMessagesClient 或 MessageTemplateClient。 您也可以使用會實作 com.azure.core.http.HttpClient 介面的任何自訂 HTTP 用戶端來初始化用戶端。

為了簡單起見，本快速入門會使用連接字串進行驗證。 在實際執行環境中，我們建議服務主體。

在 Azure 入口網站中從 Azure 通訊服務資源取得連接字串。 在左側瀏覽至 Keys 索引標籤。複製 Connection string 的 Primary key 欄位。 連接字串格式如下：endpoint=https://{your Azure Communication Services resource name}.communication.azure.com/;accesskey={secret key}。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [主索引鍵] 區段中的 [連接字串] 欄位。

將環境變數 COMMUNICATION_SERVICES_CONNECTION_STRING 設定為連接字串的值。
開啟主控台視窗並輸入下列命令：

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

如需如何為系統設定環境變數的詳細資訊，請遵循將連接字串儲存在環境變數中的步驟。

若要具現化 NotificationMessagesClient，請將下列程式碼新增至 main 方法：

// You can get your connection string from your resource in the Azure portal.
String connectionString = System.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING");

NotificationMessagesClient notificationClient = new NotificationMessagesClientBuilder()
    .connectionString(connectionString)
    .buildClient();

設定頻道註冊識別碼

頻道註冊識別碼 GUID 是在頻道註冊期間建立。 您可以在入口網站中的 Azure 通訊服務資源 [頻道] 索引標籤上查閱。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [頻道] 索引標籤。重點在 [頻道識別碼] 欄位的複製動作上。

將其指派給名為 channelRegistrationId 的變數。

String channelRegistrationId = "<your channel registration id GUID>";

設定收件者清單

您必須提供與 WhatsApp 帳戶相關聯的真實電話號碼。 此 WhatsApp 帳戶會接收本快速入門中傳送的文字和媒體訊息。 針對本快速入門，此電話號碼可能是您的個人電話號碼。

收件者電話號碼不能是與 WhatsApp 頻道註冊相關聯的商務電話號碼 (傳送者識別碼)。 傳送者識別碼會顯示為傳送給收件者之文字和媒體訊息的傳送者。

電話號碼應包含國碼 (地區碼)。 如需電話號碼格式的詳細資訊，請參閱 whatsApp 文件中的電話號碼格式。

注意

收件者清單中目前僅支援一個電話號碼。

建立如下的收件者清單：

List<String> recipientList = new ArrayList<>();
recipientList.add("<to WhatsApp phone number>");

範例：

// Example only
List<String> recipientList = new ArrayList<>();
recipientList.add("+14255550199");

開始在企業與 WhatsApp 使用者之間傳送訊息

WhatsApp Business 帳戶與 WhatsApp 使用者之間的交談可以透過下列兩種方式來開始：

  • 企業將範本訊息傳送給 WhatsApp 使用者。
  • WhatsApp 使用者將任何訊息傳送給企業號碼。

不論交談如何開始，企業只能傳送範本訊息，直到使用者傳送訊息給企業為止。只有在使用者傳送訊息給企業之後，企業才能在作用中交談期間將文字或媒體訊息傳送給使用者。 一旦 24 小時交談視窗過期，就必須重新開始交談。 若要深入了解交談，請參閱 WhatsApp Business Platform 中的定義。

(選項 1) 從企業起始交談 - 傳送範本訊息

藉由傳送範本訊息來起始交談。

首先，使用範本的值建立 MessageTemplate。

注意

若要檢查可用的範本，請參閱清單範本中的指示。 如果您沒有可使用的範本，請繼續選項 2。

以下是使用預設範本 sample_template 建立的 MessageTemplate。
如果 sample_template 無法使用，請跳至選項 2。 若是進階使用者，請參閱範本頁面，以了解如何使用選項 1 傳送不同的範本。

訊息 SDK 可讓 Contoso 將範本 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送範本訊息，需要以下詳細資料：

// Assemble the template content
String templateName = "sample_template";
String templateLanguage = "en_us";
MessageTemplate messageTemplate = new MessageTemplate(templateName, templateLanguage);

// Assemble template message
TemplateNotificationContent templateContent = new TemplateNotificationContent(channelRegistrationId, recipientList, messageTemplate);

// Send template message
SendMessageResult templateMessageResult = notificationClient.send(templateContent);

// Process result
for (MessageReceipt messageReceipt : templateMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

現在，使用者必須回應範本訊息。 從 WhatsApp 使用者帳戶，回覆從 WhatsApp Business 帳戶接收到的範本訊息。 訊息的內容與此案例無關。

重要

收件者必須回應範本訊息才能起始交談，將文字或媒體訊息傳遞給收件者。

(選項 2) 從使用者起始交談

在 WhatsApp Business 帳戶與 WhatsApp 使用者之間起始交談的另一個選項是讓使用者起始交談。 若要這樣做，請從您的個人 WhatsApp 帳戶，將訊息傳送至您的企業號碼 (傳送者識別碼)。

Web 上檢視的 WhatsApp 交談，其中顯示傳送至 WhatsApp Business 帳戶號碼的使用者訊息。

將文字訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 傳送文字 WhatsApp 訊息，該訊息會起始 WhatsApp 使用者起始的項目。 若要傳送文字訊息，需要以下詳細資料：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

在此範例中，我們會以「感謝您的意見反應。來自通知傳訊 SDK」這段文字\n回覆 WhatsApp 使用者。

組合然後傳送文字訊息：

// Assemble text message
TextNotificationContent textContent = new TextNotificationContent(channelRegistrationId, recipientList, "“Thanks for your feedback.\n From Notification Messaging SDK");

// Send text message
SendMessageResult textMessageResult = notificationClient.send(textContent);

// Process result
for (MessageReceipt messageReceipt : textMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

將媒體訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將媒體（影像、視訊、音訊或檔）訊息傳送給 WhatsApp 使用者。 若要傳送內嵌媒體訊息，您需要：

重要

若要將媒體訊息傳送至 WhatsApp 使用者，WhatsApp 用戶必須先將訊息傳送至 WhatsApp 商務帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

重要

從 SDK 1.1.0 版起， MediaNotificationContent 映射即將淘汰。 建議您使用 ImageNotificationContent 來傳送影像，並探索其他媒體類型的特定內容類別，例如 DocumentNotificationContent、 VideoNotificationContent和 AudioNotificationContent。

傳送影像訊息

接著，組合傳送影像訊息：

// Assemble image message
String imageUrl = "https://example.com/image.jpg";
ImageNotificationContent imageContent = new ImageNotificationContent(channelRegistrationId, recipientList, imageUrl);

// Send image message
SendMessageResult imageMessageResult = notificationClient.send(imageContent);

// Process result
for (MessageReceipt messageReceipt : imageMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

傳送視訊訊息

然後組合傳送影片訊息：

// Assemble video message
String videoUrl = "https://example.com/video.mp4";
VideoNotificationContent videoContent = new VideoNotificationContent(channelRegistrationId, recipientList, videoUrl);

// Send video message
SendMessageResult videoMessageResult = notificationClient.send(videoContent);

// Process result
for (MessageReceipt messageReceipt : videoMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

傳送音訊訊息

然後組合傳送音訊訊息：

// Assemble audio message
String audioUrl = "https://example.com/audio.mp3";
AudioNotificationContent audioContent = new AudioNotificationContent(channelRegistrationId, recipientList, audioUrl);

// Send audio message
SendMessageResult audioMessageResult = notificationClient.send(audioContent);

// Process result
for (MessageReceipt messageReceipt : audioMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

傳送文件訊息

然後組合傳送檔案訊息：

// Assemble document message
String docUrl = "https://example.com/document.pdf";
DocumentNotificationContent docContent = new DocumentNotificationContent(channelRegistrationId, recipientList, docUrl);

// Send document message
SendMessageResult docMessageResult = notificationClient.send(docContent);

// Process result
for (MessageReceipt messageReceipt : docMessageResult.getReceipts()) {
    System.out.println("Message sent to:" + messageReceipt.getTo() + " and message id:" + messageReceipt.getMessageId());
}

執行程式碼

  1. 瀏覽至包含 pom.xml 檔案的目錄，然後使用 mvn 命令來編譯專案。

    mvn compile

  2. 藉由執行下列 mvn 命令來執行應用程式。

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

完整範例程式碼

在 GitHub 上尋找本快速入門的最終程式碼。

必要條件

設定

若要設定傳送訊息的環境，請執行下列各節中的步驟。

建立新的 Node.js 應用程式

  1. 開啟您的終端機或命令視窗，接著執行下列命令，為您的應用程式建立新的目錄，並瀏覽至該目錄。

    mkdir advance-messages-quickstart && cd advance-messages-quickstart

  2. 執行下列命令，以使用預設設定建立 package.json 檔案。

    npm init -y

  3. 使用文字編輯器，在專案根目錄中建立名為 send-messages.js 的檔案。

  4. 將下列程式碼片段新增至 send-messages.js 檔案。

    async function main() {
    // Quickstart code goes here.
}

main().catch((error) => {
    console.error("Encountered an error while sending message: ", error);
    process.exit(1);
});

在下列各節中，您會將本快速入門的所有原始程式碼新增至您建立的 send-messages.js 檔案中。

Install the package

使用 npm install 命令，以安裝適用於 JavaScript 的 Azure 通訊服務進階傳訊 SDK。

npm install @azure-rest/communication-messages --save

--save 選項會在您的 package.json 檔案中，將程式庫列為相依性。

物件模型

下列類別和介面會處理適用於 JavaScript 的 Azure 通訊服務進階傳訊 SDK 的一些主要功能。

名稱 描述
MessageClient 此類別會連線至您的 Azure 通訊服務資源。 它會傳送訊息。
MessageTemplate 此類別會定義您使用的範本，以及訊息範本屬性的內容。

程式碼範例

請遵循下列步驟，將必要的程式碼片段新增至 send-messages.js 檔案的 Main 函式。

驗證用戶端

以下程式碼會使用 dotenv 套件從名為 COMMUNICATION_SERVICES_CONNECTION_STRING 的環境變數中，擷取資源的連接字串。

為了簡單起見，本快速入門會使用連接字串進行驗證。 在實際執行環境中，我們建議服務主體。

在 Azure 入口網站中從 Azure 通訊服務資源取得連接字串。 在左側瀏覽至 Keys 索引標籤。複製 Connection string 的 Primary key 欄位。 連接字串格式如下：endpoint=https://{your Azure Communication Services resource name}.communication.azure.com/;accesskey={secret key}。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [主索引鍵] 區段中的 [連接字串] 欄位。

將環境變數 COMMUNICATION_SERVICES_CONNECTION_STRING 設定為連接字串的值。
開啟主控台視窗並輸入下列命令：

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

如需如何為系統設定環境變數的詳細資訊，請遵循將連接字串儲存在環境變數中的步驟。

若要具現化 MessageClient，請將下列程式碼新增至 Main 方法：

const MessageClient = require("@azure-rest/communication-messages").default;

// Set Connection string
const connectionString = process.env["COMMUNICATION_SERVICES_CONNECTION_STRING"];

// Instantiate the client
const client = MessageClient(connectionString);

設定頻道註冊識別碼

頻道註冊識別碼 GUID 是在頻道註冊期間建立。 您可以在入口網站中的 Azure 通訊服務資源 [頻道] 索引標籤上查閱。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [頻道] 索引標籤。重點在 [頻道識別碼] 欄位的複製動作上。

將其指派給名為 channelRegistrationId 的變數。

const channelRegistrationId = "<your channel registration id GUID>";

設定收件者清單

您必須提供與 WhatsApp 帳戶相關聯的真實電話號碼。 此 WhatsApp 帳戶會接收本快速入門中傳送的範本、文字和媒體訊息。 針對本快速入門，此電話號碼可能是您的個人電話號碼。

收件者電話號碼不能是與 WhatsApp 頻道註冊相關聯的商務電話號碼 (傳送者識別碼)。 傳送者識別碼會顯示為傳送給收件者之文字和媒體訊息的傳送者。

電話號碼應包含國碼 (地區碼)。 如需電話號碼格式的詳細資訊，請參閱 whatsApp 文件中的電話號碼格式。

注意

收件者清單中目前僅支援一個電話號碼。

建立如下的收件者清單：

const recipientList = ["<to WhatsApp phone number>"];

範例：

// Example only
const recipientList = ["+14255550199"];

開始在企業與 WhatsApp 使用者之間傳送訊息

WhatsApp Business 帳戶與 WhatsApp 使用者之間的交談可以透過下列兩種方式來開始：

  • 企業將範本訊息傳送給 WhatsApp 使用者。
  • WhatsApp 使用者將任何訊息傳送給企業號碼。

不論交談如何開始，企業只能傳送範本訊息，直到使用者傳送訊息給企業為止。只有在使用者傳送訊息給企業之後，企業才能在作用中交談期間將文字或媒體訊息傳送給使用者。 一旦 24 小時交談視窗過期，就必須重新開始交談。 若要深入了解交談，請參閱 WhatsApp Business Platform 中的定義。

(選項 1) 從企業起始交談 - 傳送範本訊息

藉由傳送範本訊息來起始交談。

首先，使用範本的值建立 MessageTemplate。

注意

若要檢查可用的範本，請參閱清單範本中的指示。 如果您沒有可使用的範本，請繼續選項 2。

以下是使用預設範本 sample_template 建立的 MessageTemplate。
如果 sample_template 無法使用，請跳至選項 2。 若是進階使用者，請參閱範本頁面，以了解如何使用選項 1 傳送不同的範本。

訊息 SDK 可讓 Contoso 將範本 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送範本訊息，需要以下詳細資料：

// Assemble the template content
const template = {
    name: "sample_template",
    language: "en_US"
};

如需如何組合 MessageTemplate 以及如何建立您自己範本的更多範例，請參閱下列資源：

如需範本的進一步 WhatsApp 需求，請參閱 WhatsApp Business Platform API 參考：

// Send template message
const templateMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "template",
        template: template
    }
});

// Process result
if (templateMessageResult.status === "202") {
    templateMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

現在，使用者必須回應範本訊息。 從 WhatsApp 使用者帳戶，回覆從 WhatsApp Business 帳戶接收到的範本訊息。 訊息的內容與此案例無關。

重要

收件者必須回應範本訊息才能起始交談，將文字或媒體訊息傳遞給收件者。

(選項 2) 從使用者起始交談

在 WhatsApp Business 帳戶與 WhatsApp 使用者之間起始交談的另一個選項是讓使用者起始交談。 若要這樣做，請從您的個人 WhatsApp 帳戶，將訊息傳送至您的企業號碼 (傳送者識別碼)。

Web 上檢視的 WhatsApp 交談，其中顯示傳送至 WhatsApp Business 帳戶號碼的使用者訊息。

將文字訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 傳送文字 WhatsApp 訊息，該訊息會起始 WhatsApp 使用者起始的項目。 若要傳送文字訊息，需要以下詳細資料：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

在此範例中，我們會以「感謝您的意見反應。來自通知傳訊 SDK」這段文字\n回覆 WhatsApp 使用者。

組合並傳送媒體訊息：

// Send text message
const textMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "text",
        content: "Thanks for your feedback.\n From Notification Messaging SDK"
    }
});

// Process result
if (textMessageResult.status === "202") {
    textMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

將媒體訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將媒體（影像、視訊、音訊或檔）訊息傳送給 WhatsApp 使用者。 若要傳送內嵌媒體訊息，您需要：

重要

若要將媒體訊息傳送至 WhatsApp 使用者，WhatsApp 用戶必須先將訊息傳送至 WhatsApp 商務帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

重要

從 SDK 2.0.0 版起， MediaNotificationContent 映射即將淘汰。 建議您使用 ImageNotificationContent 來傳送影像，並探索其他媒體類型的特定內容類別，例如 DocumentNotificationContent、 VideoNotificationContent和 AudioNotificationContent。

傳送影像內容

若要傳送影像訊息，請提供影像的URL。 例如，

const url = "https://example.com/image.jpg";

組合並傳送媒體訊息：

// Send image message
const mediaMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "image",
        mediaUri: url
    }
});

// Process result
if (mediaMessageResult.status === "202") {
    mediaMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

傳送視訊內容

若要傳送影片訊息，請提供影片的URL。 例如，

const url = "https://example.com/video.mp4";

組合並傳送影片訊息：

// Send video message
const mediaMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "video",
        mediaUri: url
    }
});

// Process result
if (mediaMessageResult.status === "202") {
    mediaMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

傳送音訊內容

若要傳送音訊訊息，請提供音訊檔案的URL。 例如，

const url = "https://example.com/audio.mp3";

組合並傳送音訊訊息：

// Send audio message
const mediaMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "audio",
        mediaUri: url
    }
});

// Process result
if (mediaMessageResult.status === "202") {
    mediaMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

傳送文件內容

若要傳送文件訊息，請提供檔的URL。 例如，

const url = "https://example.com/document.pdf";

組合並傳送檔案訊息：

// Send document message
const mediaMessageResult = await client.path("/messages/notifications:send").post({
    contentType: "application/json",
    body: {
        channelRegistrationId: channelRegistrationId,
        to: recipientList,
        kind: "document",
        mediaUri: url
    }
});

// Process result
if (mediaMessageResult.status === "202") {
    mediaMessageResult.body.receipts.forEach((receipt) => {
        console.log("Message sent to:"+receipt.to+" with message id:"+receipt.messageId);
    });
} else {
    throw new Error("Failed to send message");
}

執行程式碼

使用節點命令來執行您新增至 send-messages.js 檔案的程式碼。

node ./send-messages.js

完整範例程式碼

您可以從 GitHub 下載應用程式範例。

必要條件

設定

建立新的 Python 應用程式

在終端或主控台視窗中，為您的應用程式建立新資料夾並瀏覽至該資料夾。

mkdir messages-quickstart && cd messages-quickstart

Install the package

您需要使用適用於 Python 1.0.0 版或更新版本的 Azure 通訊訊息用戶端程式庫。

從主控台提示字元中，執行下列命令：

pip install azure-communication-messages

設定應用程式架構

建立名為 messages-quickstart.py 的新檔案，並新增基本程式結構。

type nul > messages-quickstart.py

基本程式結構

import os

class MessagesQuickstart(object):
    print("Azure Communication Services - Advanced Messages SDK Quickstart")

if __name__ == '__main__':
    messages = MessagesQuickstart()

物件模型

下列類別和介面會處理適用於 Python 的 Azure 通訊服務訊息 SDK 的一些主要功能。

名稱 描述
NotificationMessagesClient 此類別會連線至您的 Azure 通訊服務資源。 它會傳送訊息。
MessageTemplate 此類別會定義您使用的範本，以及訊息範本屬性的內容。
TemplateNotificationContent 此類別會定義您要傳送之範本訊息的「對象」和「內容」。
TextNotificationContent 此類別會定義您要傳送之文字訊息的「對象」和「內容」。
ImageNotificationContent 此類別會定義您要傳送之影像媒體訊息的「對象」和「內容」。
DocumentNotificationContent 這個類別會定義您要傳送之文件媒體訊息的「誰」和「內容」。
VideoNotificationContent 此類別會定義您想要傳送之視訊媒體訊息的「誰」和「內容」。
AudioNotificationContent 這個類別會定義您要傳送之音訊媒體訊息的「誰」和「內容」。

程式碼範例

請遵循下列步驟，將必要的程式碼片段新增至 messages-quickstart.py Python 程式。

驗證用戶端

訊息傳送是使用 NotificationMessagesClient 完成。 NotificationMessagesClient 是使用在 Azure 入口網站中從 Azure 通訊服務資源取得的連接字串進行驗證。 如需連接字串的詳細資訊，請參閱存取您的連接字串和服務端點 (部分機器翻譯)。

如螢幕快照所示，從 Azure 入口網站 取得 Azure 通訊資源 連接字串。 在左側瀏覽至 Keys 索引標籤。複製主索引鍵的 Connection string 欄位。 連接字串格式如下：endpoint=https://{your Azure Communication Services resource name}.communication.azure.com/;accesskey={secret key}。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [索引鍵] 區段中的 [主索引鍵] 欄位。

將環境變數 COMMUNICATION_SERVICES_CONNECTION_STRING 設定為連接字串的值。
開啟主控台視窗並輸入下列命令：

setx COMMUNICATION_SERVICES_CONNECTION_STRING "<your connection string>"

新增環境變數之後，您可能需要重新啟動任何需要讀取環境變數的執行中程式，包括主控台視窗。 例如，如果您使用 Visual Studio 作為編輯器，請在執行範例前重新啟動 Visual Studio。

如需如何為系統設定環境變數的詳細資訊，請遵循將連接字串儲存在環境變數中的步驟。

    # Get a connection string to our Azure Communication Services resource.
    connection_string = os.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING")
    
    def send_template_message(self):
        from azure.communication.messages import NotificationMessagesClient

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)

設定頻道註冊識別碼

頻道註冊識別碼 GUID 是在頻道註冊期間建立。 您可以在入口網站中的 Azure 通訊服務資源 [頻道] 索引標籤上查閱。

顯示 Azure 入口網站中 Azure 通訊服務資源的螢幕擷取畫面，檢視 [頻道] 索引標籤。重點在 [頻道識別碼] 欄位的複製動作上。

將其指派給名為 channelRegistrationId 的變數。

    channelRegistrationId = os.getenv("WHATSAPP_CHANNEL_ID_GUID")

設定收件者清單

您必須提供與 WhatsApp 帳戶相關聯的真實電話號碼。 此 WhatsApp 帳戶會接收本快速入門中傳送的範本、文字和媒體訊息。 針對本快速入門，此電話號碼可能是您的個人電話號碼。

收件者電話號碼不能是與 WhatsApp 頻道註冊相關聯的商務電話號碼 (傳送者識別碼)。 傳送者識別碼會顯示為傳送給收件者之文字和媒體訊息的傳送者。

電話號碼應包含國碼 (地區碼)。 如需電話號碼格式的詳細資訊，請參閱 whatsApp 文件中的電話號碼格式。

注意

收件者清單中目前僅支援一個電話號碼。

設定如下的收件者清單：

    phone_number = os.getenv("RECIPIENT_WHATSAPP_PHONE_NUMBER")

使用範例：

    # Example only
    to=[self.phone_number],

開始在企業與 WhatsApp 使用者之間傳送訊息

WhatsApp Business 帳戶與 WhatsApp 使用者之間的交談可以透過下列兩種方式來開始：

  • 企業將範本訊息傳送給 WhatsApp 使用者。
  • WhatsApp 使用者將任何訊息傳送給企業號碼。

不論交談如何開始，企業只能傳送範本訊息，直到使用者傳送訊息給企業為止。只有在使用者傳送訊息給企業之後，企業才能在作用中交談期間將文字或媒體訊息傳送給使用者。 一旦 24 小時交談視窗過期，就必須重新開始交談。 若要深入了解交談，請參閱 WhatsApp Business Platform 中的定義。

(選項 1) 從企業起始交談 - 傳送範本訊息

藉由傳送範本訊息來起始交談。

首先，使用範本的值建立 MessageTemplate。

注意

若要檢查可用的範本，請參閱清單範本中的指示。 如果您沒有可使用的範本，請繼續選項 2。

以下是使用預設範本 sample_template 建立的 MessageTemplate。
如果 sample_template 無法使用，請跳至選項 2。 若是進階使用者，請參閱範本頁面，以了解如何使用選項 1 傳送不同的範本。

訊息 SDK 可讓 Contoso 將範本 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送範本訊息，需要以下詳細資料：

如需如何組合 MessageTemplate 以及如何建立您自己範本的更多範例，請參閱下列資源：

如需範本的進一步 WhatsApp 需求，請參閱 WhatsApp Business Platform API 參考：

若要傳送 WhatsApp 範本訊息，請在 send_template_message（self） 函式中新增指定的程式代碼。

        input_template: MessageTemplate = MessageTemplate(
            name="<<template_name>>",
            language="<<template_language>>")
        template_options = TemplateNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            template=input_template
        )

        # calling send() with whatsapp template details
        message_responses = messaging_client.send(template_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Templated Message with message id {} was successfully sent to {}."
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

將 send_template_message() 呼叫新增至 Main 方法。

    # Calling send_template_message()
    messages.send_template_message()

現在，使用者必須回應範本訊息。 從 WhatsApp 使用者帳戶，回覆從 WhatsApp Business 帳戶接收到的範本訊息。 訊息的內容與此案例無關。

重要

收件者必須回應範本訊息才能起始交談，將文字或媒體訊息傳遞給收件者。

(選項 2) 從使用者起始交談

在 WhatsApp Business 帳戶與 WhatsApp 使用者之間起始交談的另一個選項是讓使用者起始交談。 若要這樣做，請從您的個人 WhatsApp 帳戶，將訊息傳送至您的企業號碼 (傳送者識別碼)。

Web 上檢視的 WhatsApp 交談，其中顯示傳送至 WhatsApp Business 帳戶號碼的使用者訊息。

將文字訊息傳送給 WhatsApp 使用者

訊息 SDK 可讓 Contoso 傳送文字 WhatsApp 訊息，該訊息會起始 WhatsApp 使用者起始的項目。 若要傳送文字訊息，需要以下詳細資料：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

在此範例中，我們會以「感謝您的意見反應。\n 來自通知傳訊 SDK」文字回復 WhatsApp 使用者。

    def send_text_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TextNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        text_options = TextNotificationContent (
            channel_registration_id=self.channelRegistrationId,
            to= [self.phone_number],
            content="Thanks for your feedback.\n From Notification Messaging SDK",
        )
        
        # calling send() with whatsapp message details
        message_responses = messaging_client.send(text_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Text Message with message id {} was successfully sent to {}."
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

若要執行 send_text_message（），請更新 main方法

    #Calling send_text_message()
    messages.send_text_message()

將影像媒體訊息傳送至 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將影像 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送影像內嵌訊息，需要以下詳細資料：

重要

若要將文字訊息傳送給 WhatsApp 使用者，WhatsApp 使用者必須先將訊息傳送至 WhatsApp Business 帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

傳送媒體 WhatsApp 訊息時使用 media_uri 的範例。

input_media_uri: str = "https://aka.ms/acsicon1"

    def send_image_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( ImageNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "https://aka.ms/acsicon1"
        image_message_options = ImageNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Image containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

若要執行 send_text_message（），請更新 main方法

    # Calling send_image_message()
    messages.send_image_message()

將文件媒體訊息傳送至 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將影像 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送影像內嵌訊息，需要以下詳細資料：

重要

若要將文件訊息傳送至 WhatsApp 使用者，WhatsApp 用戶必須先將訊息傳送至 WhatsApp 商務帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

傳送媒體 WhatsApp 訊息時使用 media_uri 的範例。

input_media_uri： str = “##DocumentLinkPlaceholder##”

    def send_document_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( DocumentNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##DocumentLinkPlaceholder##"
        documents_options = DocumentNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            caption="Hello World via Advanced Messaging SDK.This is document message",
            file_name="Product roadmap timeline.pptx",
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(documents_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Document containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

若要執行 send_text_message（），請更新 main方法

    # Calling send_image_message()
    messages.send_image_message()

將音訊媒體訊息傳送至 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將影像 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送影像內嵌訊息，需要以下詳細資料：

重要

若要將音訊訊息傳送至 WhatsApp 使用者，WhatsApp 用戶必須先將訊息傳送至 WhatsApp 商務帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

傳送媒體 WhatsApp 訊息時使用 media_uri 的範例。

input_media_uri： str = “##AudioLinkPlaceholder##”

    def send_audio_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( AudioNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##AudioLinkPlaceholder##"
        audio_options = AudioNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(audio_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Audio containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

若要執行 send_text_message（），請更新 main方法

    # Calling send_image_message()
    messages.send_image_message()

將視訊媒體訊息傳送至 WhatsApp 使用者

訊息 SDK 可讓 Contoso 將影像 WhatsApp 訊息傳送給 WhatsApp 使用者。 若要傳送影像內嵌訊息，需要以下詳細資料：

重要

若要將影片訊息傳送至 WhatsApp 使用者，WhatsApp 用戶必須先將訊息傳送至 WhatsApp 商務帳戶。 如需詳細資訊，請參閱開始在企業與 WhatsApp 使用者之間傳送訊息。

傳送媒體 WhatsApp 訊息時使用 media_uri 的範例。

input_media_uri： str = “##VideoLinkPlaceholder##”

    def send_video_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( VideoNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##VideoLinkPlaceholder##"
        video_options = VideoNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Video containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

若要執行 send_text_message（），請更新 main方法

    # Calling send_image_message()
    messages.send_image_message()

執行程式碼

若要執行程式碼，請確定您位於 messages-quickstart.py 檔案所在的目錄中。

python messages-quickstart.py

Azure Communication Services - Advanced Messages Quickstart
WhatsApp Templated Message with message id <<GUID>> was successfully sent to <<ToRecipient>>
WhatsApp Text Message with message id <<GUID>> was successfully sent to <<ToRecipient>>
WhatsApp Image containing Message with message id <<GUID>> was successfully sent to <<ToRecipient>>

完整範例程式碼

import os

class MessagesQuickstart(object):
    print("Azure Communication Services - Advanced Messages SDK Quickstart using connection string.")
    # Advanced Messages SDK implementations goes in this section.
   
    connection_string = os.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING")
    phone_number = os.getenv("RECIPIENT_PHONE_NUMBER")
    channelRegistrationId = os.getenv("WHATSAPP_CHANNEL_ID")

    def send_template_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TemplateNotificationContent , MessageTemplate )

        # client creation
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_template: MessageTemplate = MessageTemplate(
            name="<<TEMPLATE_NAME>>",
            language="<<LANGUAGE>>")
        template_options = TemplateNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            template=input_template
        )

        # calling send() with WhatsApp template details.
        message_responses = messaging_client.send(template_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Templated Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_text_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( TextNotificationContent )

        # client creation
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)

        text_options = TextNotificationContent (
            channel_registration_id=self.channelRegistrationId,
            to= [self.phone_number],
            content="Hello World via ACS Advanced Messaging SDK.",
        )
        
        # calling send() with WhatsApp message details
        message_responses = messaging_client.send(text_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Text Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_image_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( ImageNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "https://aka.ms/acsicon1"
        image_message_options = ImageNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Image containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")
    
    def send_document_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( DocumentNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##DocumentLinkPlaceholder##"
        documents_options = DocumentNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            caption="Hello World via Advanced Messaging SDK.This is document message",
            file_name="Product roadmap timeline.pptx",
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(documents_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Document containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_audio_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( AudioNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##AudioLinkPlaceholder##"
        audio_options = AudioNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(audio_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Audio containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

    def send_video_message(self):
        from azure.communication.messages import NotificationMessagesClient
        from azure.communication.messages.models import ( VideoNotificationContent)

        # Create NotificationMessagesClient Client
        messaging_client = NotificationMessagesClient.from_connection_string(self.connection_string)
        input_media_uri: str = "##VideoLinkPlaceholder##"
        video_options = VideoNotificationContent(
            channel_registration_id=self.channelRegistrationId,
            to=[self.phone_number],
            media_uri=input_media_uri,
        )

        # calling send() with whatsapp image message
        message_responses = messaging_client.send(image_message_options)
        response = message_responses.receipts[0]
        
        if (response is not None):
            print("WhatsApp Video containing Message with message id {} was successfully sent to {}"
            .format(response.message_id, response.to))
        else:
            print("Message failed to send")

if __name__ == '__main__':
    messages = MessagesQuickstart()
    messages.send_template_message()
    messages.send_text_message()
    messages.send_image_message()
    messages.send_document_message()
    messages.send_audio_message()
    messages.send_video_message()

注意

請更新上述程式代碼中的所有佔位元變數。

其他範例

您可以在 GitHub 上檢閱並下載 Python 訊息 SDK 的其他範例程式碼。

下一步

在本快速入門中，您已試用 WhatsApp SDK 的進階傳訊。 接下來，您可能也想要查看下列文章：