Class: Twilio::REST::Api::V2010::AccountContext::ValidationRequestList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/validation_request.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ ValidationRequestList

Initialize the ValidationRequestList

Parameters:



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/validation_request.rb', line 22

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/OutgoingCallerIds.json"
end

Instance Method Details

#create(phone_number: nil, friendly_name: :unset, call_delay: :unset, extension: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ ValidationRequestInstance

Retrieve a single page of ValidationRequestInstance records from the API. Request is executed immediately.

Parameters:

  • phone_number (String) (defaults to: nil) —

    The phone number to verify. Should be formatted with a ‘+’ and country code e.g., +16175551212 ([E.164](en.wikipedia.org/wiki/E.164) format). Twilio will also accept unformatted US numbers e.g., (415) 555-1212, 415-555-1212.

  • friendly_name (String) (defaults to: :unset) —

    A human readable description for the new caller ID with maximum length 64 characters. Defaults to a nicely formatted version of the number.

  • call_delay (String) (defaults to: :unset) —

    The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.

  • extension (String) (defaults to: :unset) —

    Digits to dial after connecting the verification call.

  • status_callback (String) (defaults to: :unset) —

    A URL that Twilio will request when the verification call ends to notify your app if the verification process was successful or not. See [StatusCallback parameter](www.twilio.com/docs/api/voice/outgoing-caller-ids#statuscallback-parameter) below.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method Twilio should use when requesting the above URL. Defaults to POST.

Returns:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/api/v2010/account/validation_request.rb', line 50

def create(phone_number: nil, friendly_name: :unset, call_delay: :unset, extension: :unset, status_callback: :unset, status_callback_method: :unset)
  data = Twilio::Values.of({
      'PhoneNumber' => phone_number,
      'FriendlyName' => friendly_name,
      'CallDelay' => call_delay,
      'Extension' => extension,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  ValidationRequestInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end

#to_s ⇒ Object

Provide a user friendly representation



71
72
73
 
# File 'lib/twilio-ruby/rest/api/v2010/account/validation_request.rb', line 71

def to_s
  '#<Twilio.Api.V2010.ValidationRequestList>'
end