bandwidth v1.1.1 → Overview → Bandwidth → Resources → Messages

Bandwidth.Resources.Messages

Summary
Functions

The Messages resource lets you send SMS/MMS messages and view messages that were previously sent or received.

Summary↑

create(client, message)	Send a message
find(client, id)	Get information about a message
list(client, params \\ [])	Get a list of previous messages

Functions

create(client, message)

(function) # ↑

Specs:

create(Client.t, Map.t) :: Client.response

Send a message.

Example:

message = %{ from: "+12223334444", to: "+3335557777", text: "HEY!" }
case Bandwidth.Resources.Messages.create(client, message) do
  {:ok, {201, _, _}} -> IO.puts "Message sent"
  {:error, reason}   -> IO.puts "Error: #{reason}"
end

Bandwidth Docs

find(client, id)

(function) # ↑

Specs:

find(Client.t, binary) :: Client.response

Get information about a message.

Example:

case Bandwidth.Resources.Messages.find(client, "some-message-id") do
  {:ok, {200, message, _}} -> IO.inspect message
  {:error, reason}         -> IO.puts "Error: #{reason}"
end

Bandwidth Docs

list(client, params \\ [])

(function) # ↑

Specs:

list(Client.t, Client.params) :: Client.response

Get a list of previous messages.

Example:

# List all previously sent messages
case Bandwidth.Resources.Messages.list(client) do
  {:ok, {200, messages, _}} -> IO.inspect messages
  {:error, reason}          -> IO.puts "Error: #{reason}"
end

# List messages sent by a specific number.
case Bandwidth.Resources.Messages.list(client, from: "+12223334444") do
  {:ok, {200, messages, _}} -> IO.inspect messages
  {:error, reason}          -> IO.puts "Error: #{reason}"
end

Bandwidth Docs