Class: Twilio::REST::Api::V2010::AccountContext::CallContext::UserDefinedMessageSubscriptionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, call_sid: nil) ⇒ UserDefinedMessageSubscriptionList

Initialize the UserDefinedMessageSubscriptionList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the Account that subscribed to the User Defined Messages.

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

    The SID of the Call the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 27

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

  # Path Solution
  @solution = {account_sid: , call_sid: call_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/UserDefinedMessageSubscriptions.json"
end

Instance Method Details

#create(callback: nil, idempotency_key: :unset, method: :unset) ⇒ UserDefinedMessageSubscriptionInstance

Create the UserDefinedMessageSubscriptionInstance

Parameters:

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

    The URL we should call using the ‘method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).

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

    A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.

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

    The HTTP method Twilio will use when requesting the above ‘Url`. Either `GET` or `POST`. Default is `POST`.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 45

def create(callback: nil, idempotency_key: :unset, method: :unset)
  data = Twilio::Values.of({
      'Callback' => callback,
      'IdempotencyKey' => idempotency_key,
      'Method' => method,
  })

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

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

#to_s ⇒ Object

Provide a user friendly representation



64
65
66
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb', line 64

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