Packages

ash_dispatch

0.6.7
0.8.5 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.3 0.7.2 0.7.1 0.7.0 0.6.14 0.6.13 0.6.12 0.6.11 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.6 0.5.5 0.5.4 0.5.3 0.5.1 0.5.0 0.1.4 retired 0.1.3 retired 0.1.1 retired 0.1.0 retired

Event-driven notification system for Ash Framework with multiple transport types

HexDocs Report package

Current section

Files

Jump to
Documentation
Changelog
License
35 Versions
11 Dependencies
Dependants
Files
Activity
ash_dispatch lib sms_backend.ex
Raw

lib/sms_backend.ex 

defmodule AshDispatch.SMSBackend do
  @moduledoc """
  Behaviour that an SMS backend module implements. Configure a backend
  in your app config:

      config :ash_dispatch, :sms_backend, MyApp.SMS

  The transport (`AshDispatch.Transports.SMS`) will call your backend's
  `deliver/4` whenever an event channel with `transport: :sms` fires.

  ## Implementation contract

  - Read `receipt.recipient` (phone number — your responsibility to
    validate format) and `receipt.content[:body]`/`:message` for the
    SMS body.
  - Send the SMS via your provider's API.
  - Update the receipt via Ash:
    - On success: `for_update(:mark_sent, %{provider_id: provider_id})`
    - On failure: `for_update(:mark_failed, %{error_message: reason})`
  - Return `{:ok, updated_receipt}` or `{:error, reason}`.

  Most backends are thin wrappers around HTTP clients (Twilio, Vonage,
  Telavox SMS, etc.).
  """

  @callback deliver(
              receipt :: struct(),
              context :: AshDispatch.Context.t(),
              channel :: AshDispatch.Channel.t(),
              event_config :: map()
            ) :: {:ok, struct()} | {:error, term()}
end