Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource.
- #address_requirements ⇒ AddressRequirement
-
#address_sid ⇒ String
The SID of the Address resource associated with the phone number.
-
#api_version ⇒ String
The API version used to start a new TwiML session.
-
#assigned_add_ons ⇒ assigned_add_ons
Access the assigned_add_ons.
-
#beta ⇒ Boolean
Whether the phone number is new to the Twilio platform.
-
#bundle_sid ⇒ String
The SID of the Bundle resource that you associate with the phone number.
- #capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities
-
#context ⇒ IncomingPhoneNumberContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the IncomingPhoneNumberInstance.
-
#emergency_address_sid ⇒ String
The SID of the emergency address configuration that we use for emergency calling from this phone number.
- #emergency_address_status ⇒ EmergencyAddressStatus
- #emergency_status ⇒ EmergencyStatus
-
#fetch ⇒ IncomingPhoneNumberInstance
Fetch the IncomingPhoneNumberInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#identity_sid ⇒ String
The SID of the Identity resource that we associate with the phone number.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance
constructor
Initialize the IncomingPhoneNumberInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#origin ⇒ String
The phone number’s origin.
-
#phone_number ⇒ String
The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
-
#sid ⇒ String
The unique string that that we created to identify this IncomingPhoneNumber resource.
-
#sms_application_sid ⇒ String
The SID of the application that handles SMS messages sent to the phone number.
-
#sms_fallback_method ⇒ String
The HTTP method we use to call
sms_fallback_url. -
#sms_fallback_url ⇒ String
The URL that we call when an error occurs while retrieving or executing the TwiML from
sms_url. -
#sms_method ⇒ String
The HTTP method we use to call
sms_url. -
#sms_url ⇒ String
The URL we call when the phone number receives an incoming SMS message.
- #status ⇒ String
-
#status_callback ⇒ String
The URL we call using the
status_callback_methodto send status information to your application. -
#status_callback_method ⇒ String
The HTTP method we use to call
status_callback. -
#to_s ⇒ Object
Provide a user friendly representation.
-
#trunk_sid ⇒ String
The SID of the Trunk that handles calls to the phone number.
-
#update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset) ⇒ IncomingPhoneNumberInstance
Update the IncomingPhoneNumberInstance.
-
#uri ⇒ String
The URI of the resource, relative to
https://api.twilio.com. -
#voice_application_sid ⇒ String
The SID of the application that handles calls to the phone number.
-
#voice_caller_id_lookup ⇒ Boolean
Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up).
-
#voice_fallback_method ⇒ String
The HTTP method we use to call
voice_fallback_url. -
#voice_fallback_url ⇒ String
The URL that we call when an error occurs retrieving or executing the TwiML requested by
url. -
#voice_method ⇒ String
The HTTP method we use to call
voice_url. - #voice_receive_mode ⇒ VoiceReceiveMode
-
#voice_url ⇒ String
The URL we call when the phone number receives a call.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance
Initialize the IncomingPhoneNumberInstance
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 876 def initialize(version, payload , account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'address_sid' => payload['address_sid'], 'address_requirements' => payload['address_requirements'], 'api_version' => payload['api_version'], 'beta' => payload['beta'], 'capabilities' => payload['capabilities'], 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'friendly_name' => payload['friendly_name'], 'identity_sid' => payload['identity_sid'], 'phone_number' => payload['phone_number'], 'origin' => payload['origin'], 'sid' => payload['sid'], 'sms_application_sid' => payload['sms_application_sid'], 'sms_fallback_method' => payload['sms_fallback_method'], 'sms_fallback_url' => payload['sms_fallback_url'], 'sms_method' => payload['sms_method'], 'sms_url' => payload['sms_url'], 'status_callback' => payload['status_callback'], 'status_callback_method' => payload['status_callback_method'], 'trunk_sid' => payload['trunk_sid'], 'uri' => payload['uri'], 'voice_receive_mode' => payload['voice_receive_mode'], 'voice_application_sid' => payload['voice_application_sid'], 'voice_caller_id_lookup' => payload['voice_caller_id_lookup'], 'voice_fallback_method' => payload['voice_fallback_method'], 'voice_fallback_url' => payload['voice_fallback_url'], 'voice_method' => payload['voice_method'], 'voice_url' => payload['voice_url'], 'emergency_status' => payload['emergency_status'], 'emergency_address_sid' => payload['emergency_address_sid'], 'emergency_address_status' => payload['emergency_address_status'], 'bundle_sid' => payload['bundle_sid'], 'status' => payload['status'], } # Context @instance_context = nil @params = { 'account_sid' => account_sid ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource.
936 937 938 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 936 def account_sid @properties['account_sid'] end |
#address_requirements ⇒ AddressRequirement
948 949 950 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 948 def address_requirements @properties['address_requirements'] end |
#address_sid ⇒ String
Returns The SID of the Address resource associated with the phone number.
942 943 944 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 942 def address_sid @properties['address_sid'] end |
#api_version ⇒ String
Returns The API version used to start a new TwiML session.
954 955 956 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 954 def api_version @properties['api_version'] end |
#assigned_add_ons ⇒ assigned_add_ons
Access the assigned_add_ons
1236 1237 1238 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1236 def assigned_add_ons context.assigned_add_ons end |
#beta ⇒ Boolean
Returns Whether the phone number is new to the Twilio platform. Can be: true or false.
960 961 962 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 960 def beta @properties['beta'] end |
#bundle_sid ⇒ String
Returns The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
1128 1129 1130 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1128 def bundle_sid @properties['bundle_sid'] end |
#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities
966 967 968 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 966 def capabilities @properties['capabilities'] end |
#context ⇒ IncomingPhoneNumberContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
927 928 929 930 931 932 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 927 def context unless @instance_context @instance_context = IncomingPhoneNumberContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
972 973 974 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 972 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
978 979 980 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 978 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the IncomingPhoneNumberInstance
1141 1142 1143 1144 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1141 def delete context.delete end |
#emergency_address_sid ⇒ String
Returns The SID of the emergency address configuration that we use for emergency calling from this phone number.
1116 1117 1118 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1116 def emergency_address_sid @properties['emergency_address_sid'] end |
#emergency_address_status ⇒ EmergencyAddressStatus
1122 1123 1124 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1122 def emergency_address_status @properties['emergency_address_status'] end |
#emergency_status ⇒ EmergencyStatus
1110 1111 1112 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1110 def emergency_status @properties['emergency_status'] end |
#fetch ⇒ IncomingPhoneNumberInstance
Fetch the IncomingPhoneNumberInstance
1149 1150 1151 1152 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1149 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
984 985 986 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 984 def friendly_name @properties['friendly_name'] end |
#identity_sid ⇒ String
Returns The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.
990 991 992 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 990 def identity_sid @properties['identity_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
1249 1250 1251 1252 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1249 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>" end |
#origin ⇒ String
Returns The phone number’s origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.
1002 1003 1004 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1002 def origin @properties['origin'] end |
#phone_number ⇒ String
Returns The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
996 997 998 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 996 def phone_number @properties['phone_number'] end |
#sid ⇒ String
Returns The unique string that that we created to identify this IncomingPhoneNumber resource.
1008 1009 1010 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1008 def sid @properties['sid'] end |
#sms_application_sid ⇒ String
Returns The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.
1014 1015 1016 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1014 def sms_application_sid @properties['sms_application_sid'] end |
#sms_fallback_method ⇒ String
Returns The HTTP method we use to call sms_fallback_url. Can be: GET or POST.
1020 1021 1022 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1020 def sms_fallback_method @properties['sms_fallback_method'] end |
#sms_fallback_url ⇒ String
Returns The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.
1026 1027 1028 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1026 def sms_fallback_url @properties['sms_fallback_url'] end |
#sms_method ⇒ String
Returns The HTTP method we use to call sms_url. Can be: GET or POST.
1032 1033 1034 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1032 def sms_method @properties['sms_method'] end |
#sms_url ⇒ String
Returns The URL we call when the phone number receives an incoming SMS message.
1038 1039 1040 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1038 def sms_url @properties['sms_url'] end |
#status ⇒ String
1134 1135 1136 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1134 def status @properties['status'] end |
#status_callback ⇒ String
Returns The URL we call using the status_callback_method to send status information to your application.
1044 1045 1046 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1044 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
Returns The HTTP method we use to call status_callback. Can be: GET or POST.
1050 1051 1052 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1050 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
1242 1243 1244 1245 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1242 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>" end |
#trunk_sid ⇒ String
Returns The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
1056 1057 1058 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1056 def trunk_sid @properties['trunk_sid'] end |
#update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset) ⇒ IncomingPhoneNumberInstance
Update the IncomingPhoneNumberInstance
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1180 def update( account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset ) context.update( account_sid: account_sid, api_version: api_version, friendly_name: friendly_name, sms_application_sid: sms_application_sid, sms_fallback_method: sms_fallback_method, sms_fallback_url: sms_fallback_url, sms_method: sms_method, sms_url: sms_url, status_callback: status_callback, status_callback_method: status_callback_method, voice_application_sid: voice_application_sid, voice_caller_id_lookup: voice_caller_id_lookup, voice_fallback_method: voice_fallback_method, voice_fallback_url: voice_fallback_url, voice_method: voice_method, voice_url: voice_url, emergency_status: emergency_status, emergency_address_sid: emergency_address_sid, trunk_sid: trunk_sid, voice_receive_mode: voice_receive_mode, identity_sid: identity_sid, address_sid: address_sid, bundle_sid: bundle_sid, ) end |
#uri ⇒ String
Returns The URI of the resource, relative to https://api.twilio.com.
1062 1063 1064 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1062 def uri @properties['uri'] end |
#voice_application_sid ⇒ String
Returns The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
1074 1075 1076 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1074 def voice_application_sid @properties['voice_application_sid'] end |
#voice_caller_id_lookup ⇒ Boolean
Returns Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.
1080 1081 1082 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1080 def voice_caller_id_lookup @properties['voice_caller_id_lookup'] end |
#voice_fallback_method ⇒ String
Returns The HTTP method we use to call voice_fallback_url. Can be: GET or POST.
1086 1087 1088 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1086 def voice_fallback_method @properties['voice_fallback_method'] end |
#voice_fallback_url ⇒ String
Returns The URL that we call when an error occurs retrieving or executing the TwiML requested by url.
1092 1093 1094 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1092 def voice_fallback_url @properties['voice_fallback_url'] end |
#voice_method ⇒ String
Returns The HTTP method we use to call voice_url. Can be: GET or POST.
1098 1099 1100 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1098 def voice_method @properties['voice_method'] end |
#voice_receive_mode ⇒ VoiceReceiveMode
1068 1069 1070 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1068 def voice_receive_mode @properties['voice_receive_mode'] end |
#voice_url ⇒ String
Returns The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.
1104 1105 1106 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 1104 def voice_url @properties['voice_url'] end |