Sha256: 1e8434be5a793cbd6c30658e964319b8cdf6ca030817bfa13d409bd1c8a5fb93

Contents?: true

Size: 1005 Bytes

Versions: 7

Compression:

Stored size: 1005 Bytes

Contents

module TMS #:nodoc:
  # A VoiceMessage is used to create and send a voice message to a collection of Recipient
  # objects.  The recipients are called and the provided +play_url+ is 
  # played to them.  Accepted sound formats include +wav+, +mp3+, and +aiff+. 
  # 
  #
  # @attr play_url [String] The url to the sound file to be played back to the call recipients
  # 
  # @example
  #    voice_message = client.voice_messages.build(:play_url => "http://example.com/emergency_weather.mp3")
  #    voice_message.recipients.build(:phone => "+18001002000")
  #    voice_message.post
  #    voice_message.get
  class VoiceMessage
    include InstanceResource

    # @!parse attr_accessor :play_url
    writeable_attributes :play_url

    # @!parse attr_reader :created_at, :completed_at, :status
    readonly_attributes :created_at, :completed_at, :status

    ##
    # A CollectionResource of Recipient objects
    collection_attributes :recipients

    def self.to_s
      "VoiceMessage"
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
tms_client-0.4.1 lib/tms_client/resource/voice_message.rb
tms_client-0.4.0 lib/tms_client/resource/voice_message.rb
tms_client-0.3.0 lib/tms_client/resource/voice_message.rb
tms_client-0.2.2 lib/tms_client/resource/voice_message.rb
tms_client-0.2.1 lib/tms_client/resource/voice_message.rb
tms_client-0.2.0 lib/tms_client/resource/voice_message.rb
tms_client-0.1.1 lib/tms_client/resource/voice_message.rb