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

Bandwidth.Resources.Conferences.Members

Manage conference members.

Summary↑

add(client, conference_id, member)

Add members to a conference
find(client, conference_id, member_id)

Retrieve properties for a single conference member
list(client, conference_id)

List all members of a conference
update(client, conference_id, member_id, member)

Update a conference member (remove, mute, hold)

Functions

add(client, conference_id, member)
(function) # ↑

Specs:

  • add(Client.t, binary, Map.t) :: Client.response

Add members to a conference.

Example:

member = %{ callId: "some-call-id" }
case Bandwidth.Resources.Conferences.Members.add(client, "some-conference-id", member) do
  {:ok, {201, _, _}} -> IO.puts "Member added"
  {:error, reason}   -> IO.puts "Error: #{reason}"
end

Bandwidth Docs

find(client, conference_id, member_id)
(function) # ↑

Specs:

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

Retrieve properties for a single conference member.

Example:

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

Bandwidth Docs

list(client, conference_id)
(function) # ↑

Specs:

  • list(Client.t, binary) :: Client.response

List all members of a conference.

Example:

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

Bandwidth Docs

update(client, conference_id, member_id, member)
(function) # ↑

Specs:

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

Update a conference member (remove, mute, hold).

Example:

# Remove a member from a conference
member = %{ state: "completed" }
case Bandwidth.Resources.Conferences.Members.update(client, "some-conference-id", "some-member-id", member) do
  {:ok, {200, _, _}} -> IO.puts "Member removed"
  {:error, reason}   -> IO.puts "Error: #{reason}"
end

Bandwidth Docs