opentok 4.1.0 → 4.5.1

data/lib/opentok/client.rb

@@ -188,6 +188,33 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def select_streams_for_archive(archive_id, opts)
+      opts.extend(HashExtensions)
+      body = opts.camelize_keys!
+      response = self.class.patch("/v2/project/#{@api_key}/archive/#{archive_id}/streams", {
+          :body => body.to_json,
+          :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 204
+        response
+      when 400
+        raise OpenTokArchiveError, "The request was invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. API Key: #{@api_key}"
+      when 404
+        raise OpenTokArchiveError, "No matching archive found with the specified ID: #{archive_id}"
+      when 405
+        raise OpenTokArchiveError, "The archive was started with streamMode set to 'auto', which does not support stream manipulation."
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokArchiveError, "The archive streams could not be updated."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
     def forceDisconnect(session_id, connection_id)
       response = self.class.delete("/v2/project/#{@api_key}/session/#{session_id}/connection/#{connection_id}", {
           :headers => generate_headers("Content-Type" => "application/json")
@@ -206,6 +233,45 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def force_mute_stream(session_id, stream_id)
+      response = self.class.post("/v2/project/#{@api_key}/session/#{session_id}/stream/#{stream_id}/mute", {
+          :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise ArgumentError, "Force mute failed. Stream ID #{stream_id} or Session ID #{session_id} is invalid"
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. API Key: #{@api_key}"
+      when 404
+        raise OpenTokConnectionError, "Either Stream ID #{stream_id} or Session ID #{session_id} is invalid"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def force_mute_session(session_id, opts)
+      opts.extend(HashExtensions)
+      body = opts.camelize_keys!
+      response = self.class.post("/v2/project/#{@api_key}/session/#{session_id}/mute", {
+          :body => body.to_json,
+          :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise ArgumentError, "Force mute failed. The request could not be processed due to a bad request"
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. API Key: #{@api_key}"
+      when 404
+        raise OpenTokConnectionError, "Session ID #{session_id} is invalid"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
     def signal(session_id, connection_id, opts)
       opts.extend(HashExtensions)
       connectionPath = connection_id.to_s.empty? ? "" : "/connection/#{connection_id}"
@@ -257,6 +323,52 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def play_dtmf_to_connection(session_id, connection_id, dtmf_digits)
+      body = { "digits" => dtmf_digits }
+
+      response = self.class.post("/v2/project/#{@api_key}/session/#{session_id}/connection/#{connection_id}/play-dtmf", {
+        :body => body.to_json,
+        :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise ArgumentError, "One of the properties — dtmf_digits #{dtmf_digits} or session_id #{session_id} — is invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. This can occur if you use an invalid OpenTok API key or an invalid JSON web token. API Key: #{@api_key}"
+      when 404
+        raise OpenTokError, "The specified session #{session_id} does not exist or the client specified by the #{connection_id} property is not connected to the session."
+      else
+        raise OpenTokError, "An error occurred when attempting to play DTMF digits to the session"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def play_dtmf_to_session(session_id, dtmf_digits)
+      body = { "digits" => dtmf_digits }
+
+      response = self.class.post("/v2/project/#{@api_key}/session/#{session_id}/play-dtmf", {
+        :body => body.to_json,
+        :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise ArgumentError, "One of the properties — dtmf_digits #{dtmf_digits} or session_id #{session_id} — is invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. This can occur if you use an invalid OpenTok API key or an invalid JSON web token. API Key: #{@api_key}"
+      when 404
+        raise OpenTokError, "The specified session does not exist. Session ID: #{session_id}"
+      else
+        raise OpenTokError, "An error occurred when attempting to play DTMF digits to the session"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
     def info_stream(session_id, stream_id)
       streamId = stream_id.to_s.empty? ? '' : "/#{stream_id}"
       url = "/v2/project/#{@api_key}/session/#{session_id}/stream#{streamId}"
@@ -371,6 +483,28 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def list_broadcasts(offset, count, session_id)
+      query = Hash.new
+      query[:offset] = offset unless offset.nil?
+      query[:count] = count unless count.nil?
+      query[:sessionId] = session_id unless session_id.nil?
+      response = self.class.get("/v2/project/#{@api_key}/broadcast", {
+        :query => query.empty? ? nil : query,
+        :headers => generate_headers,
+      })
+      case response.code
+      when 200
+        response
+      when 403
+        raise OpenTokAuthenticationError,
+          "Authentication failed while retrieving broadcasts. API Key: #{@api_key}"
+      else
+        raise OpenTokBroadcastError, "The broadcasts could not be retrieved."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
     def layout_broadcast(broadcast_id, opts)
       opts.extend(HashExtensions)
       response = self.class.put("/v2/project/#{@api_key}/broadcast/#{broadcast_id}/layout", {
@@ -393,5 +527,122 @@ module OpenTok
       raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
     end
 
+    def select_streams_for_broadcast(broadcast_id, opts)
+      opts.extend(HashExtensions)
+      body = opts.camelize_keys!
+      response = self.class.patch("/v2/project/#{@api_key}/broadcast/#{broadcast_id}/streams", {
+          :body => body.to_json,
+          :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 204
+        response
+      when 400
+        raise OpenTokBroadcastError, "The request was invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed. API Key: #{@api_key}"
+      when 404
+        raise OpenTokBroadcastError, "No matching broadcast found with the specified ID: #{broadcast_id}"
+      when 405
+        raise OpenTokBroadcastError, "The broadcast was started with streamMode set to 'auto', which does not support stream manipulation."
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokBroadcastError, "The broadcast streams could not be updated."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def start_render(session_id, opts)
+      opts.extend(HashExtensions)
+      body = { :sessionId => session_id }.merge(opts.camelize_keys!)
+      response = self.class.post("/v2/project/#{@api_key}/render", {
+          :body => body.to_json,
+          :headers => generate_headers("Content-Type" => "application/json")
+      })
+      case response.code
+      when 202
+        response
+      when 400
+        raise OpenTokRenderError, "The render could not be started. The request was invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed while starting a render. API Key: #{@api_key}"
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokRenderError, "The render could not be started"
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def get_render(render_id)
+      response = self.class.get("/v2/project/#{@api_key}/render/#{render_id}", {
+          :headers => generate_headers
+      })
+      case response.code
+      when 200
+        response
+      when 400
+        raise OpenTokRenderError, "The request was invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed while getting a render. API Key: #{@api_key}"
+      when 404
+        raise OpenTokRenderError, "No matching render found (with the specified ID)"
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokRenderError, "Could not fetch render information."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def stop_render(render_id)
+      response = self.class.delete("/v2/project/#{@api_key}/render/#{render_id}", {
+          :headers => generate_headers
+      })
+      case response.code
+      when 204
+        response
+      when 400
+        raise OpenTokRenderError, "The request was invalid."
+      when 403
+        raise OpenTokAuthenticationError, "Authentication failed while stopping a render. API Key: #{@api_key}"
+      when 404
+        raise OpenTokRenderError, "No matching render found (with the specified ID) or it is already stopped"
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokRenderError, "The render could not be stopped."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
+    def list_renders(offset, count)
+      query = Hash.new
+      query[:offset] = offset unless offset.nil?
+      query[:count] = count unless count.nil?
+      response = self.class.get("/v2/project/#{@api_key}/render", {
+        :query => query.empty? ? nil : query,
+        :headers => generate_headers,
+      })
+      case response.code
+      when 200
+        response
+      when 403
+        raise OpenTokAuthenticationError,
+          "Authentication failed while retrieving renders. API Key: #{@api_key}"
+      when 500
+        raise OpenTokError, "OpenTok server error."
+      else
+        raise OpenTokRenderError, "The renders could not be retrieved."
+      end
+    rescue StandardError => e
+      raise OpenTokError, "Failed to connect to OpenTok. Response code: #{e.message}"
+    end
+
   end
 end

data/lib/opentok/connections.rb

@@ -25,4 +25,4 @@ module OpenTok
     end
 
   end
-end
+end

data/lib/opentok/constants.rb

@@ -1,4 +1,5 @@
 module OpenTok
+  require "set"
   API_URL = "https://api.opentok.com"
   TOKEN_SENTINEL = "T1=="
   ROLES = { subscriber: "subscriber", publisher: "publisher", moderator: "moderator" }

data/lib/opentok/exceptions.rb

@@ -14,5 +14,7 @@ module OpenTok
   class OpenTokStreamLayoutError < OpenTokError; end
   # Defines errors raised when you perform Broadcast operations.
   class OpenTokBroadcastError < OpenTokError; end
-
+  # Defines errors raised when you perform Experience Composer render operations.
+  class OpenTokRenderError < OpenTokError; end
+  
 end

data/lib/opentok/opentok.rb

@@ -1,3 +1,6 @@
+require "resolv"
+require "set"
+
 require "opentok/constants"
 require "opentok/session"
 require "opentok/client"
@@ -8,9 +11,7 @@ require "opentok/sip"
 require "opentok/streams"
 require "opentok/signals"
 require "opentok/broadcasts"
-
-require "resolv"
-require "set"
+require "opentok/renders"
 
 module OpenTok
   # Contains methods for creating OpenTok sessions and generating tokens. It also includes
@@ -42,9 +43,9 @@ module OpenTok
   #       streams, and signal. (This is the default value if you do not specify a role.)
   #
   #     * <code>:moderator</code> -- In addition to the privileges granted to a
-  #       publisher, in clients using the OpenTok.js library, a moderator can call the
-  #       <code>forceUnpublish()</code> and <code>forceDisconnect()</code> method of the
-  #       Session object.
+  #       publisher, a moderator can perform moderation functions, such as forcing clients
+  #       to disconnect, to stop publishing streams, or to mute audio in published streams. See the
+  #       {https://tokbox.com/developer/guides/moderation/ Moderation developer guide}.
   #   @option options [integer] :expire_time The expiration time, in seconds since the UNIX epoch.
   #     Pass in 0 to use the default expiration time of 24 hours after the token creation time.
   #     The maximum expiration time is 30 days after the creation time.
@@ -77,8 +78,8 @@ module OpenTok
     # @param [String] api_key The OpenTok API key for your
     #   {https://tokbox.com/account OpenTok project}.
     # @param [String] api_secret Your OpenTok API key.
-    # @option opts [Symbol] :api_url Do not set this parameter. It is for internal use by TokBox.
-    # @option opts [Symbol] :ua_addendum Do not set this parameter. It is for internal use by TokBox.
+    # @option opts [Symbol] :api_url Do not set this parameter. It is for internal use by Vonage.
+    # @option opts [Symbol] :ua_addendum Do not set this parameter. It is for internal use by Vonage.
     # @option opts [Symbol] :timeout_length Custom timeout in seconds. If not provided, defaults to 2 seconds.
     def initialize(api_key, api_secret, opts={})
       @api_key = api_key.to_s()
@@ -192,6 +193,11 @@ module OpenTok
       @broadcasts ||= Broadcasts.new client
     end
 
+    # A Renders object, which lets you work with OpenTok Experience Composer renders.
+    def renders
+      @renders ||= Renders.new client
+    end
+
     # A Sip object, which lets you use the OpenTok SIP gateway.
     def sip
       @sip ||= Sip.new client
@@ -207,14 +213,14 @@ module OpenTok
       @signals ||= Signals.new client
     end
 
-    # A Connections object, which lets disconnect clients from an OpenTok session.
+    # A Connections object, which lets you disconnect clients from an OpenTok session.
     def connections
       @connections ||= Connections.new client
     end
 
     protected
     def client
-      @client ||= Client.new api_key, api_secret, api_url, ua_addendum
+      @client ||= Client.new api_key, api_secret, api_url, ua_addendum, timeout_length: @timeout_length
     end
 
   end

data/lib/opentok/render.rb

@@ -0,0 +1,78 @@
+require "active_support/inflector"
+
+module OpenTok
+  # Represents an  Experience Composer render of an OpenTok session.
+  # See {https://tokbox.com/developer/guides/experience-composer/ Experience Composer}.
+  #
+  # @attr [string] id
+  #   The unique ID for the Experience Composer.
+  #
+  # @attr [string] session_id
+  #   The session ID of the OpenTok session associated with this render.
+  #
+  # @attr [string] project_id
+  #   The API key associated with the render.
+  #
+  # @attr [int] created_at
+  #   The time the Experience Composer started, expressed in milliseconds since the Unix epoch.
+  #
+  # @attr [int] updated_at
+  #   The UNIX timestamp when the Experience Composer status was last updated.
+  #
+  # @attr [string] url
+  #   A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
+  #
+  # @attr [string] resolution
+  #   The resolution of the Experience Composer (either "640x480", "480x640", "1280x720", "720x1280", "1920x1080", or "1080x1920").
+  #
+  # @attr [string] status
+  #   The status of the Experience Composer. Poll frequently to check status updates. This property set to one of the following:
+  #     - "starting" — The Vonage Video API platform is in the process of connecting to the remote application at the URL provided. This is the initial state.
+  #     - "started" — The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
+  #     - "stopped" — The Experience Composer has stopped.
+  #     - "failed" — An error occurred and the Experience Composer could not proceed. It may occur at startup if the OpenTok server cannot connect to the remote 
+  #                   application server or republish the stream. It may also occur at any point during the process due to an error in the Vonage Video API platform.
+  #
+  # @attr [string] reason
+  #   The reason field is only available when the status is either "stopped" or "failed". If the status is stopped, the reason field will contain either
+  #      "Max Duration Exceeded" or "Stop Requested." If the status is failed, the reason will contain a more specific error message.
+  #
+  # @attr [string] streamId
+  #   The ID of the composed stream being published. The streamId is not available when the status is "starting" and may not be available when the status is "failed".
+  class Render
+
+    # @private
+    def initialize(interface, json)
+      @interface = interface
+      # TODO: validate json fits schema
+      @json = json
+    end
+
+    # A JSON-encoded string representation of the Experience Composer render.
+    def to_json
+      @json.to_json
+    end
+
+    # Stops the OpenTok Experience Composer render.
+    def stop
+      # TODO: validate returned json fits schema
+      @json = @interface.stop @json['id']
+    end
+
+    # Gets info about the OpenTok Experience Composer render.
+    def info
+    # TODO: validate returned json fits schema
+      @json = @interface.find @json['id']
+    end
+    
+    # @private ignore
+    def method_missing(method, *args, &block)
+      camelized_method = method.to_s.camelize(:lower)
+      if @json.has_key? camelized_method and args.empty?
+        @json[camelized_method]
+      else
+        super method, *args, &block
+      end
+    end
+  end
+end

data/lib/opentok/render_list.rb

@@ -0,0 +1,14 @@
+require "opentok/render"
+
+module OpenTok
+  # A class for accessing an array of Experience Composer Render objects.
+  class RenderList < Array
+    # The total number of Experience Composer renders.
+    attr_reader :total
+
+    def initialize(interface, json)
+      @total = json["count"]
+      super json["items"].map { |item| ::OpenTok::Render.new interface, item }
+    end
+  end
+end

data/lib/opentok/renders.rb

@@ -0,0 +1,101 @@
+require "opentok/client"
+require "opentok/render"
+require "opentok/render_list"
+
+module OpenTok
+  # A class for working with OpenTok Experience Composer renders.
+  # See {https://tokbox.com/developer/guides/experience-composer/ Experience Composer}.
+  class Renders
+
+    # @private
+    def initialize(client)
+      @client = client
+    end
+
+    # Starts an Experience Composer render for an OpenTok session.
+    #
+    # @param [String] session_id (Required) The session ID of the OpenTok session that will include the Experience Composer stream.
+    #
+    # @param [Hash] options (Required) A hash defining options for the render.
+    #
+    # @option options [String] :token (Required) A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream.
+    #
+    # @option options [String] :url (Required) A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
+    #   The minimum length of the URL is 15 characters and the maximum length is 2048 characters.
+    #
+    # @option options [Integer] :max_duration (Optional) The maximum time allowed for the Experience Composer, in seconds. After this time, it is stopped 
+    #   automatically, if it is still running. The maximum value is 36000 (10 hours), the minimum value is 60 (1 minute), and the default value is 7200 (2 hours). 
+    #   When the Experience Composer ends, its stream is unpublished and an event is posted to the callback URL, if configured in the Account Portal.
+    #
+    # @option options [String] :resolution The resolution of the Experience Composer, either "640x480" (SD landscape), "480x640" (SD portrait), "1280x720" (HD landscape),
+    #  "720x1280" (HD portrait), "1920x1080" (FHD landscape), or "1080x1920" (FHD portrait). By default, this resolution is "1280x720" (HD landscape, the default).
+    #
+    # @option options [Hash] :properties (Optional) The initial configuration of Publisher properties for the composed output stream. The properties object contains
+    #  the key <code>:name</code> (String) which serves as the name of the composed output stream which is published to the session. The name must have a minimum length of 1 and 
+    #  a maximum length of 200.
+    #
+    # @return [Render] The render object, which includes properties defining the render, including the render ID.
+    #
+    # @raise [OpenTokRenderError] The render could not be started. The request was invalid.
+    # @raise [OpenTokAuthenticationError] Authentication failed while starting a render. Invalid API key.
+    # @raise [OpenTokError] OpenTok server error.
+    def start(session_id, options = {})
+      raise ArgumentError, "session_id not provided" if session_id.to_s.empty?
+      raise ArgumentError, "options cannot be empty" if options.empty?
+      raise ArgumentError, "token property is required in options" unless options.has_key?(:token)
+      raise ArgumentError, "url property is required in options" unless options.has_key?(:url)
+
+      render_json = @client.start_render(session_id, options)
+      Render.new self, render_json
+    end
+
+    # Stops an OpenTok Experience Composer render.
+    #
+    # @param [String] render_id (Required) The render ID.
+    #
+    # @return [Render] The render object, which includes properties defining the render.
+    #
+    # @raise [OpenTokRenderError] The request was invalid.
+    # @raise [OpenTokAuthenticationError] Authentication failed while stopping a render. Invalid API key.
+    # @raise [OpenTokRenderError] No matching render found (with the specified ID) or it is already stopped
+    # @raise [OpenTokError] OpenTok server error.
+    def stop(render_id)
+      raise ArgumentError, "render_id not provided" if render_id.to_s.empty?
+
+      render_json = @client.stop_render(render_id)
+      Render.new self, render_json
+    end
+
+    # Gets a Render object for the given render ID.
+    #
+    # @param [String] render_id (Required) The render ID.
+    #
+    # @return [Render] The render object, which includes properties defining the render.
+    #
+    # @raise [OpenTokRenderError] The request was invalid.
+    # @raise [OpenTokAuthenticationError] Authentication failed while stopping a render. Invalid API key.
+    # @raise [OpenTokRenderError] No matching render found (with the specified ID) or it is already stopped
+    # @raise [OpenTokError] OpenTok server error.
+    def find(render_id)
+      raise ArgumentError, "render_id not provided" if render_id.to_s.empty?
+
+      render_json = @client.get_render(render_id.to_s)
+      Render.new self, render_json
+    end
+
+    # Returns a RenderList, which is an array of Experience Composers renders that are associated with a project.
+    #
+    # @param [Hash] options  A hash with keys defining which range of renders to retrieve.
+    # @option options [integer] :offset (Optional). The start offset for the list of Experience Composer renders. The default is 0.
+    # @option options [integer] :count Optional. The number of Experience Composer renders to retrieve starting at the offset. The default value
+    #  is 50 and the maximum is 1000.
+    #
+    # @return [RenderList] An RenderList object, which is an array of Render objects.
+    def list(options = {})
+      raise ArgumentError, "Limit is invalid" unless options[:count].nil? || (0..1000).include?(options[:count])
+
+      render_list_json = @client.list_renders(options[:offset], options[:count])
+      RenderList.new self, render_list_json
+    end
+  end
+end

data/lib/opentok/session.rb

@@ -31,10 +31,10 @@ module OpenTok
   #     * <code>:publisher</code> -- A publisher can publish streams, subscribe to
   #       streams, and signal. (This is the default value if you do not specify a role.)
   #
-  #     * <code>:moderator</code> -- In addition to the privileges granted to a
-  #       publisher, in clients using the OpenTok.js library, a moderator can call the
-  #       <code>forceUnpublish()</code> and <code>forceDisconnect()</code> method of the
-  #       Session object.
+  #     * <code>:moderator</code> -- n addition to the privileges granted to a
+  #       publisher, a moderator can perform moderation functions, such as forcing clients
+  #       to disconnect, to stop publishing streams, or to mute audio in published streams. See the
+  #       {https://tokbox.com/developer/guides/moderation/ Moderation developer guide}.
   #   @option options [integer] :expire_time The expiration time, in seconds since the UNIX epoch.
   #     Pass in 0 to use the default expiration time of 24 hours after the token creation time.
   #     The maximum expiration time is 30 days after the creation time.

data/lib/opentok/sip.rb

@@ -12,7 +12,9 @@ module OpenTok
     #        "password" => sip_password },
     #      "headers" => { "X-KEY1" => "value1",
     #        "X-KEY1" => "value2" },
-    #      "secure" => "true"
+    #      "secure" => "true",
+    #      "video" => "true",
+    #      "observe_force_mute" => "true"
     #    }
     #    response = opentok.sip.dial(session_id, token, "sip:+15128675309@acme.pstn.example.com;transport=tls", opts)
     # @param [String] session_id The session ID corresponding to the session to which
@@ -33,14 +35,50 @@ module OpenTok
     # @option opts [Hash] :auth This object contains the username and password
     #   to be used in the the SIP INVITE​ request for HTTP digest authentication,
     #   if it is required by your SIP platform.
-    # @option opts  [true, false] :secure Wether the media must be transmitted
+    # @option opts  [true, false] :secure Whether the media must be transmitted
     #   encrypted (​true​) or not (​false​, the default).
+    # @option opts  [true, false] :video Whether the SIP call will include
+    # video (​true​) or not (​false​, the default). With video included, the SIP
+    # client's video is included in the OpenTok stream that is sent to the
+    # OpenTok session. The SIP client will receive a single composed video of
+    # the published streams in the OpenTok session.
+    # @option opts  [true, false] :observe_force_mute Whether the SIP end point
+    # observes {https://tokbox.com/developer/guides/moderation/#force_mute force mute moderation}
+    # (true) or not (false, the default).
     def dial(session_id, token, sip_uri, opts)
       response = @client.dial(session_id, token, sip_uri, opts)
     end
 
+    # Sends DTMF digits to a specific client connected to an OpnTok session.
+    #
+    # @param [String] session_id The session ID.
+    # @param [String] connection_id The connection ID of the specific connection that
+    # the DTMF signal is being sent to.
+    # @param [String] dtmf_digits The DTMF digits to send. This can include 0-9, "*", "#", and "p".
+    # A p indicates a pause of 500ms (if you need to add a delay in sending the digits).
+    def play_dtmf_to_connection(session_id, connection_id, dtmf_digits)
+      raise ArgumentError, "invalid DTMF digits" unless dtmf_digits_valid?(dtmf_digits)
+      response = @client.play_dtmf_to_connection(session_id, connection_id, dtmf_digits)
+    end
+
+    # Sends DTMF digits to all clients connected to an OpnTok session.
+    #
+    # @param [String] session_id The session ID.
+    # @param [String] dtmf_digits The DTMF digits to send. This can include 0-9, "*", "#", and "p".
+    # A p indicates a pause of 500ms (if you need to add a delay in sending the digits).
+    def play_dtmf_to_session(session_id, dtmf_digits)
+      raise ArgumentError, "invalid DTMF digits" unless dtmf_digits_valid?(dtmf_digits)
+      response = @client.play_dtmf_to_session(session_id, dtmf_digits)
+    end
+
     def initialize(client)
       @client = client
     end
+
+    private
+
+    def dtmf_digits_valid?(dtmf_digits)
+      dtmf_digits.match?(/^[0-9*#p]+$/)
+    end
   end
 end