IBeam.Communications.Sms.AzureCommunications 2.9.1

IBeam.Communications.Sms.AzureCommunications

IBeam.Communications.Sms.AzureCommunications implements ISmsService using Azure Communication Services SMS. It keeps SMS delivery behind IBeam abstractions while handling ACS option binding, connection fallback, message validation, and provider exception translation.

When To Use This

• You use Azure Communication Services for SMS delivery.
• You want application services to depend on ISmsService, not the Azure SMS SDK.
• You need provider failures translated into IBeam SMS exception types.
• You want default sender phone numbers configured centrally.

What This Package Contains

Architecture Fit

API <-- DTO/model object --> Service <-- Entity --> Repository

This package is a provider implementation. A domain service decides when an SMS should be sent and calls ISmsService; this provider sends the message through Azure Communication Services.

Quick Start

using IBeam.Communications.Abstractions;
using IBeam.Communications.Sms.AzureCommunications;

builder.Services.AddIBeamCommunications(builder.Configuration);
builder.Services.AddIBeamCommunicationsSmsAzure(builder.Configuration);

Configuration:

{
  "IBeam": {
    "Communications": {
      "Sms": {
        "FromPhoneNumber": "+16145551212",
        "DefaultToUs": true,
        "Providers": {
          "AzureCommunications": {
            "ConnectionString": "endpoint=https://example.communication.azure.com/;accesskey=..."
          }
        }
      }
    }
  }
}

Send an SMS:

public sealed class VerificationSmsService
{
    private readonly ISmsService _sms;

    public VerificationSmsService(ISmsService sms)
    {
        _sms = sms;
    }

    public Task SendVerificationCodeAsync(string phoneNumber, string code, CancellationToken ct = default)
    {
        var message = new SmsMessage
        {
            Body = $"Your verification code is {code}."
        };
        message.To.Add(phoneNumber);

        return _sms.SendAsync(message, ct: ct);
    }
}

Configuration

The provider connection string should look like:

endpoint=https://<resource>.communication.azure.com/;accesskey=<key>

Service Operations, Auditing, And Permissions

This provider does not own the business audit or permission boundary. Tag and wrap the consuming service method that decides to send SMS.

[IBeamOperation("identity.otp.send")]
public Task SendOtpAsync(Guid tenantId, Guid userId, string phoneNumber, CancellationToken ct = default)
    => _operations.ExecuteAsync(
        this,
        token => SendOtpCoreAsync(tenantId, userId, phoneNumber, token),
        new ServiceOperationExecutionOptions
        {
            TenantId = tenantId,
            EntityId = userId
        },
        ct);

Operation names can later be used by IBeam access-control rules and audit queries.

Data Storage

This package does not create database tables or durable stores.

Extension Points

Package Relationships

Extended Examples And Agent Guidance

• Project agent prompt: .agent/prompt.md
• Repository implementation guide: ../.agent/implementation-guide.md
• Consuming API migration prompt: ../IBeam.AI.Enablement/examples/consuming-api-migration-prompt.md

Troubleshooting

Version Notes

• Targets net10.0.
• Uses Azure.Communication.Sms.
• Package version is assigned by the repository release workflow.