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

Bandwidth.Resources.Conferences

Summary
Functions

The Conferences resource allows you create conferences, add members to it, play audio, speak text, mute/unmute members, hold/unhold members and other things related to conferencing. Once a conference is created there is no timeout associated with it, i.e., the conference will stay in created state until it is explicitly terminated. After the last member of a conference is removed from it, the conference will be set automatically as completed.

Bandwidth Docs

Summary↑

create(client, conference)	Create a new conference
find(client, id)	Retrieve conference information
update(client, id, conference)	Update conference

Functions

create(client, conference)

(function) # ↑

Specs:

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

Create a new conference.

Example:

case Bandwidth.Resources.Conferences.create(client, %{ from: "+12229993333" }) do
  {:ok, {201, _, _}} -> IO.puts "Call created"
  {:error, reason}   -> IO.puts "Error: #{reason}"
end

Bandwidth Docs

find(client, id)

(function) # ↑

Specs:

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

Retrieve conference information.

Example:

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

Bandwidth Docs

update(client, id, conference)

(function) # ↑

Specs:

update(Client.t, binary, Map.t) :: Client.response

Update conference.

Example:

case Bandwidth.Resources.Conferences.update(client, "some-conference-id", conference) do
  {:ok, {200, _, _}} -> IO.puts "Conference updated"
  {:error, reason}   -> IO.puts "Error: #{reason}"
end

Bandwidth Docs