Sends and schedules transactional messages.
Chimes deliver email or SMS content to inline recipients, saved customers, or template-defined recipients. A returned chime records rendering, safety, and transmission results; delivery may continue asynchronously after the API call succeeds.
Summary
Functions
Start an asynchronous SMS or email broadcast to one or more recipients.
Retrieve a sent Chime and its current transmission state.
Retrieve Chimes, optionally filtered by customer or recipient address.
Schedule one or more SMS or email notifications for future delivery.
Send one SMS or email notification immediately.
Functions
@spec broadcast(Inttegro.Client.t(), Inttegro.Chimes.BroadcastRequest.t(), keyword()) :: {:ok, Inttegro.Chimes.BroadcastCreationDetail.t()} | {:error, Exception.t()}
Start an asynchronous SMS or email broadcast to one or more recipients.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Chimes.BroadcastRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Chimes.BroadcastCreationDetail.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Chimes.BroadcastRequest.new!(request_attributes)
case Inttegro.Chimes.broadcast(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec lookup(Inttegro.Client.t(), Inttegro.Chimes.LookupRequest.t(), keyword()) :: {:ok, Inttegro.Chimes.Chime.t()} | {:error, Exception.t()}
Retrieve a sent Chime and its current transmission state.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Chimes.LookupRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Chimes.Chime.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Chimes.LookupRequest.new!(request_attributes)
case Inttegro.Chimes.lookup(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec page(Inttegro.Client.t(), Inttegro.Chimes.PageRequest.t(), keyword()) :: {:ok, Inttegro.Chimes.Page.t()} | {:error, Exception.t()}
Retrieve Chimes, optionally filtered by customer or recipient address.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Chimes.PageRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Chimes.Page.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Chimes.PageRequest.new!(request_attributes)
case Inttegro.Chimes.page(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec schedule(Inttegro.Client.t(), Inttegro.Chimes.ScheduleRequest.t(), keyword()) :: {:ok, Inttegro.Chimes.ScheduleCreationDetail.t()} | {:error, Exception.t()}
Schedule one or more SMS or email notifications for future delivery.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Chimes.ScheduleRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Chimes.ScheduleCreationDetail.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Chimes.ScheduleRequest.new!(request_attributes)
case Inttegro.Chimes.schedule(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec send(Inttegro.Client.t(), Inttegro.Chimes.SendRequest.t(), keyword()) :: {:ok, Inttegro.Chimes.Chime.t()} | {:error, Exception.t()}
Send one SMS or email notification immediately.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Chimes.SendRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Chimes.Chime.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Chimes.SendRequest.new!(request_attributes)
case Inttegro.Chimes.send(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end