Class: Ansible::Ruby::Modules::Twilio

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/notification/twilio.rb

Overview

Sends a text message to a phone number through the Twilio messaging API.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#account_sid ⇒ String

Returns user’s Twilio account token found on the account page.

Returns:

  • (String) —

    user’s Twilio account token found on the account page



11
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 11

attribute :account_sid

#auth_token ⇒ String

Returns user’s Twilio authentication token.

Returns:

  • (String) —

    user’s Twilio authentication token



15
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 15

attribute :auth_token

#from_number ⇒ String

Returns the Twilio number to send the text message from, format +15551112222.

Returns:

  • (String) —

    the Twilio number to send the text message from, format +15551112222



27
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 27

attribute :from_number

#media_url ⇒ String?

Returns a URL with a picture, video or sound clip to send with an MMS (multimedia message) instead of a plain SMS.

Returns:

  • (String, nil) —

    a URL with a picture, video or sound clip to send with an MMS (multimedia message) instead of a plain SMS



31
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 31

attribute :media_url

#msg ⇒ String

Returns the body of the text message.

Returns:

  • (String) —

    the body of the text message



19
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 19

attribute :msg

#to_number ⇒ String, ...

Returns one or more phone numbers to send the text message to, format +15551112222.

Returns:

  • (String, Array<Integer>, Integer) —

    one or more phone numbers to send the text message to, format +15551112222



23
 
# File 'lib/ansible/ruby/modules/generated/extras/notification/twilio.rb', line 23

attribute :to_number