/messagebird

A Messagebird Client, built on top of Finch.

Primary LanguageElixirMIT LicenseMIT

A Messagebird Client, built on top of Finch.

Usage

In order to use Messagebird, you must start it and provide a :name. Often in your supervision tree:

children = [
  {Messagebird, name: MyMessagebirdClient}
]

Or, in rare cases, dynamically:

Messagebird.start_link(name: MyMessagebirdClient)

Or, with the your own module:

defmodule MyMessagebirdClient do
  use Messagebird
end

children = [
  MyMessagebirdClient
]

Once you have started your instance of Messagebird, you are ready to start sending SMS messages:

config = [base_url: "https://rest.messagebird.com", access_key: "test_access_key"]

MyMessagebirdClient.send_text_message(config, "+18002345678", "Test message", originator: "TEST")

Installation

The package can be installed by adding messagebird to your list of dependencies in mix.exs:

def deps do
  [
    {:messagebird, "~> 0.1"}
  ]
end