-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Azure.Communication.Messages] Update README (#44987)
* Update Azure.Communication.Messages README
- Loading branch information
1 parent
0984ae3
commit 4ab1387
Showing
1 changed file
with
30 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,32 +19,40 @@ You need an [Azure subscription][azure_sub] and a [Communication Service Resourc | |
|
|
||
| To create a new Communication Service, you can use the [Azure Portal][communication_resource_create_portal], the [Azure PowerShell][communication_resource_create_power_shell], or the [.NET management client library][communication_resource_create_net]. | ||
|
|
||
| You must register your WhatsApp business account and have an active channel before sending messages. See [Quickstart: Register WhatsApp business account][azuredocs_register_waba] for more details | ||
|
|
||
| ### Key concepts | ||
| `NotificationMessagesClient` provides the functionality to send notification messages . | ||
| `NotificationMessagesClient` provides the functionality to send notification messages. | ||
|
|
||
| ### Using statements | ||
| ```C# | ||
| using Azure.Communication.Messages; | ||
| ``` | ||
|
|
||
| ### Authenticate the client | ||
| #### Connection String | ||
| #### Connection string | ||
|
|
||
| The NotificationMessagesClient is used for sending messages. | ||
| The MessageTemplateClient is used for retrieving template information. | ||
|
|
||
| For simplicity, this example uses a connection string to authenticate. In production environments, we recommend using Microsoft Entra ID. | ||
|
|
||
| Messages clients can be authenticated using the connection string acquired from an Azure Communication Resource in the [Azure Portal][azure_portal]. | ||
|
|
||
| ```C# | ||
| var connectionString = "<connection_string>"; // Find your Communication Services resource in the Azure portal | ||
| var connectionString = "<ConnectionString>"; // Find your Communication Services resource in the Azure portal | ||
| NotificationMessagesClient notificationMessagesClient = new NotificationMessagesClient(connectionString); | ||
| MessageTemplateClient messageTemplateClient = new MessageTemplateClient(connectionString); | ||
| ``` | ||
|
|
||
| ## Examples | ||
| ### Send an Notification Message | ||
| ### Send a notification message | ||
| To send a notification message, call the `Send` or `SendAsync` function from the `NotificationMessagesClient`. | ||
|
|
||
| #### Send a text message | ||
| ```C# | ||
| // Create the recipient list, currently only one recipient is supported | ||
| var recipient = new List<string> { "<to-phone-number>" }; | ||
| var recipient = new List<string> { "<RecipientPhoneNumber>" }; | ||
| var textContent = new = new TextNotificationContent(new Guid("<channel-registration-id>"), recipient, "Come on everyone, let's go for lunch together."); | ||
| SendMessageResult result = await notificationMessagesClient.SendAsync(textContent); | ||
| Console.WriteLine($"Message id: {result.Receipts[0].MessageId}"); | ||
|
|
@@ -53,7 +61,7 @@ Console.WriteLine($"Message id: {result.Receipts[0].MessageId}"); | |
| #### Send a template message | ||
| ```C# | ||
| // Create the recipient list, currently only one recipient is supported | ||
| var recipient = new List<string> { "<to-phone-number>" }; | ||
| var recipient = new List<string> { "<RecipientPhoneNumber>" }; | ||
| string templateName = "sample_template"; | ||
| string templateLanguage = "en_us"; | ||
| var messageTemplate = new MessageTemplate(templateName, templateLanguage); | ||
|
|
@@ -65,16 +73,15 @@ Console.WriteLine($"Message id: {result.Receipts[0].MessageId}"); | |
| #### Send a media message | ||
| ```C# | ||
| // Create the recipient list, currently only one recipient is supported | ||
| var recipient = new List<string> { "<to-phone-number>" }; | ||
| var recipient = new List<string> { "<RecipientPhoneNumber>" }; | ||
| var uri = new Uri("https://aka.ms/acsicon1"); | ||
| var mediaContent = new MediaNotificationContent(channelRegistrationId, recipientList, uri); | ||
| SendMessageResult result = await notificationMessagesClient.SendAsync(mediaContent); | ||
| Console.WriteLine($"Message id: {result.Receipts[0].MessageId}"); | ||
| ``` | ||
|
|
||
| ### Retrieve templates | ||
| To retrieve templates, call the `GetMessages` or `GetMessagesAsync` function from the `MessageTemplateClient`. | ||
|
|
||
| To retrieve templates, call the `GetTemplates` or `GetTemplatesAsync` function from the `MessageTemplateClient`. | ||
|
|
||
| ```C# | ||
| AsyncPageable<MessageTemplateItem> templates = messageTemplateClient.GetTemplatesAsync(channelId); | ||
|
|
@@ -88,8 +95,10 @@ await foreach (MessageTemplateItem template in templates) | |
| A `RequestFailedException` is thrown as a service response for any unsuccessful requests. The exception contains information about what response code was returned from the service. | ||
|
|
||
| ## Next steps | ||
| - Read more about Messages in Azure Communication Services (Link to be added). | ||
| - Read more about how to set up Event Grid subscription for new message and message delivery status (Link to be added). | ||
| - Read more about Messages in Azure Communication Services at [Advanced Messaging for WhatsApp in Azure Communication Services][azuredocs_whatsapp_overview]. | ||
| - Read more about how to set up an Event Grid subscription to receive messages and message delivery statuses at [Quickstart: Handle Advanced Messaging events][azuredocs_eventgrid_setup]. | ||
| - Read more about how to use templates at [Send WhatsApp template messages][azuredocs_templates]. | ||
| - For a set-by-step guide on how to use the Messages APIs, see [Quickstart: Send WhatsApp Messages using Advanced Messages][azuredocs_quickstart]]. | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
@@ -100,15 +109,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m | |
| <!-- LINKS --> | ||
| [source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/communication/Azure.Communication.Messages/src | ||
| [package]: https://www.nuget.org/packages/Azure.Communication.Messages | ||
| [product_docs]: https://docs.microsoft.com/azure/communication-services/overview | ||
| [product_docs]: https://learn.microsoft.com/azure/communication-services/overview | ||
| [nuget]: https://www.nuget.org | ||
| [azure_sub]: https://azure.microsoft.com/free/dotnet/ | ||
| [communication_resource_docs]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp | ||
| [communication_resource_create_portal]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp | ||
| [communication_resource_create_power_shell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice | ||
| [communication_resource_create_net]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net | ||
| [communication_resource_docs]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp | ||
| [communication_resource_create_portal]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp | ||
| [communication_resource_create_power_shell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice | ||
| [communication_resource_create_net]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net | ||
| [azure_portal]: https://portal.azure.com | ||
| [cla]: https://cla.microsoft.com | ||
| [coc]: https://opensource.microsoft.com/codeofconduct | ||
| [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq | ||
| [coc_contact]: mailto:[email protected] | ||
| [azuredocs_whatsapp_overview]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/whatsapp-overview | ||
| [azuredocs_eventgrid_setup]: https://learn.microsoft.com/azure/communication-services/quickstarts/advanced-messaging/whatsapp/handle-advanced-messaging-events | ||
| [azuredocs_register_waba]: https://learn.microsoft.com/azure/communication-services/quickstarts/advanced-messaging/whatsapp/connect-whatsapp-business-account | ||
| [azuredocs_templates]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/template-messages | ||
| [azuredocs_quickstart]: https://learn.microsoft.com/azure/communication-services/quickstarts/advanced-messaging/whatsapp/get-started?pivots=programming-language-csharp | ||