Azure.Communication.Messages 1.0.0
Prefix 已保留
dotnet add package Azure.Communication.Messages --version 1.0.0
NuGet\Install-Package Azure.Communication.Messages -Version 1.0.0
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Azure.Communication.Messages" Version="1.0.0" />
对于支持 包引用 的项目,将此 XML 节复制到项目文件中以引用该包。
paket add Azure.Communication.Messages --version 1.0.0
NuGet 团队不为此客户端提供支持。请联系其 管理员 以获取支持。
#r "nuget: Azure.Communication.Messages, 1.0.0"
#r 指令可用于 F# Interactive 和多语言笔记本。将此内容复制到交互式工具或脚本的源代码中,以引用包。
// Install Azure.Communication.Messages as a Cake Addin #addin nuget:?package=Azure.Communication.Messages&version=1.0.0 // Install Azure.Communication.Messages as a Cake Tool #tool nuget:?package=Azure.Communication.Messages&version=1.0.0
NuGet 团队不为此客户端提供支持。请联系其 管理员 以获取支持。
Azure 通信消息的 .NET 客户端库
此包包含 Azure 通信消息服务的 C# SDK。
入门
安装包
使用 NuGet 安装 Azure 通信消息的 .NET 客户端库
dotnet add package Azure.Communication.Messages
先决条件
您需要一个 Azure 订阅 和一个 通信服务资源 才能使用此包。
要创建新的通信服务,您可以使用Azure 门户、Azure PowerShell或.NET 管理客户端库。
关键概念
NotificationMessagesClient
提供了发送通知消息的功能。
使用声明
using Azure.Communication.Messages;
验证客户端
连接字符串
消息客户端可以使用从Azure 门户获取的Azure通信资源中的连接字符串进行身份验证。
var connectionString = "<connection_string>"; // Find your Communication Services resource in the Azure portal
NotificationMessagesClient notificationMessagesClient = new NotificationMessagesClient(connectionString);
MessageTemplateClient messageTemplateClient = new MessageTemplateClient(connectionString);
示例
发送通知消息
要发送通知消息,请从NotificationMessagesClient
调用Send
或SendAsync
函数。
发送文本消息
// Create the recipient list, currently only one recipient is supported
var recipient = new List<string> { "<to-phone-number>" };
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}");
发送模板消息
// Create the recipient list, currently only one recipient is supported
var recipient = new List<string> { "<to-phone-number>" };
string templateName = "sample_template";
string templateLanguage = "en_us";
var messageTemplate = new MessageTemplate(templateName, templateLanguage);
var templateContent = new TemplateNotificationContent(channelRegistrationId, recipientList, messageTemplate);
SendMessageResult result = await notificationMessagesClient.SendAsync(templateContent);
Console.WriteLine($"Message id: {result.Receipts[0].MessageId}");
发送媒体消息
// Create the recipient list, currently only one recipient is supported
var recipient = new List<string> { "<to-phone-number>" };
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}");
检索模板
要检索模板,请从MessageTemplateClient
调用GetMessages
或GetMessagesAsync
函数。
AsyncPageable<MessageTemplateItem> templates = messageTemplateClient.GetTemplatesAsync(channelId);
await foreach (MessageTemplateItem template in templates)
{
Console.WriteLine($"{template.Name}");
}
故障排除
对于任何不成功的请求,都会抛出RequestFailedException
作为服务响应。该异常包含有关从服务返回的响应代码的信息。
下一步
- 了解更多关于Azure通信服务中的消息的信息(链接待添加)。
- 了解更多如何设置新消息和消息投递状态的Event Grid订阅(链接待添加)。
贡献
此项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议(CLA),声明您拥有授予我们使用您贡献的权利,并且实际上确实授予了我们这样的权利。有关详细信息,请访问CLA。
本项目已采用Microsoft开源行为准则。有关更多信息,请参阅行为准则常见问题回答或通过[email protected]联系,以提出任何额外的问题或意见。
产品 | 版本 兼容和附加的目标框架版本。 |
---|---|
.NET | net5.0 已计算。 net5.0-windows 已计算。 net6.0 已计算。 net6.0-android 已计算。 net6.0-ios 已计算。 net6.0-maccatalyst 已计算。 net6.0-macos 已计算。 net6.0-tvos 已计算。 net6.0-windows 已计算。 net7.0 已计算。 net7.0-android 已计算。 net7.0-ios 已计算。 net7.0-maccatalyst 已计算。 net7.0-macos 已计算。 net7.0-tvos 已计算。 net7.0-windows 已计算。 net8.0 已计算。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。 |
.NET Core | netcoreapp2.0 已计算。 netcoreapp2.1 已计算。 netcoreapp2.2 已计算。 netcoreapp3.0 已计算。 netcoreapp3.1 已计算。 |
.NET Standard | netstandard2.0 兼容。 netstandard2.1 已计算。 |
.NET Framework | net461 已计算。 net462 已计算。 net463 已计算。 net47 已计算。 net471 已计算。 net472 已计算。 net48 已计算。 net481 已计算。 |
MonoAndroid | monoandroid 已计算。 |
MonoMac | monomac 已计算。 |
MonoTouch | monotouch 已计算。 |
Tizen | tizen40 已计算。 tizen60 已计算。 |
Xamarin.iOS | xamarinios 已计算。 |
Xamarin.Mac | xamarinmac 已计算。 |
Xamarin.TVOS | xamarintvos 已计算。 |
Xamarin.WatchOS | xamarinwatchos 已计算。 |
-
.NETStandard 2.0
- Azure.Communication.Common (>= 1.3.0)
- Azure.Core (>= 1.38.0)
- System.ClientModel (>= 1.0.0)
- System.Text.Json (>= 4.7.2)
NuGet 包
此包未由任何 NuGet 包使用。
GitHub 仓库
此包未由任何流行 GitHub 仓库使用。
版本 | 下载 | 最后更新 |
---|---|---|
1.0.0 | 11,888 | 2/29/2024 |
1.0.0-beta.1 | 3,502 | 10/10/2023 |