twilio.rest.api.v2010.account.incoming_phone_number package¶
Subpackages¶
Submodules¶
twilio.rest.api.v2010.account.incoming_phone_number.local module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance(version, payload, account_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource-
class
AddressRequirement[source]¶ Bases:
object-
ANY= 'any'¶
-
FOREIGN= 'foreign'¶
-
LOCAL= 'local'¶
-
NONE= 'none'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
address_requirements¶ Returns: Whether the phone number requires an Address registered with Twilio. Return type: LocalInstance.AddressRequirement
-
address_sid¶ Returns: The SID of the Address resource associated with the phone number Return type: unicode
-
api_version¶ Returns: The API version used to start a new TwiML session Return type: unicode
-
bundle_sid¶ Returns: The SID of the Bundle resource associated with number Return type: unicode
-
capabilities¶ Returns: Indicate if a phone can receive calls or messages Return type: unicode
-
date_created¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
emergency_address_sid¶ Returns: The emergency address configuration to use for emergency calling Return type: unicode
-
emergency_status¶ Returns: Whether the phone number is enabled for emergency calling Return type: LocalInstance.EmergencyStatus
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
identity_sid¶ Returns: The SID of the Identity resource associated with number Return type: unicode
-
origin¶ Returns: The phone number’s origin. Can be twilio or hosted. Return type: unicode
-
phone_number¶ Returns: The phone number in E.164 format Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
sms_application_sid¶ Returns: The SID of the Application resource to handle SMS messages Return type: unicode
-
sms_fallback_method¶ Returns: The HTTP method used with sms_fallback_url Return type: unicode
-
sms_fallback_url¶ Returns: The URL that we call when an error occurs while retrieving or executing the TwiML Return type: unicode
-
sms_method¶ Returns: The HTTP method to use with sms_url Return type: unicode
-
sms_url¶ Returns: The URL we call when the phone number receives an incoming SMS message Return type: unicode
-
status¶ Returns: The status Return type: unicode
-
status_callback¶ Returns: The URL to send status information to your application Return type: unicode
-
status_callback_method¶ Returns: The HTTP method we use to call status_callback Return type: unicode
-
trunk_sid¶ Returns: The SID of the Trunk that handles calls to the phone number Return type: unicode
-
uri¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
voice_application_sid¶ Returns: The SID of the application that handles calls to the phone number Return type: unicode
-
voice_fallback_method¶ Returns: The HTTP method used with voice_fallback_url Return type: unicode
-
voice_fallback_url¶ Returns: The URL we call when an error occurs in TwiML Return type: unicode
-
voice_method¶ Returns: The HTTP method used with the voice_url Return type: unicode
-
voice_receive_mode¶ Returns: The voice_receive_mode Return type: LocalInstance.VoiceReceiveMode
-
voice_url¶ Returns: The URL we call when this phone number receives a call Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.incoming_phone_number.local.LocalList(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(phone_number, api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, identity_sid=<object object>, address_sid=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, voice_receive_mode=<object object>, bundle_sid=<object object>)[source]¶ Create the LocalInstance
Parameters: - phone_number (unicode) – The phone number to purchase in E.164 format
- api_version (unicode) – The API version to use for incoming calls made to the new phone number
- friendly_name (unicode) – A string to describe the new phone number
- sms_application_sid (unicode) – The SID of the application to handle SMS messages
- sms_fallback_method (unicode) – The HTTP method we use to call status_callback
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms url
- sms_url (unicode) – The URL we should call when the new phone number receives an incoming SMS message
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the new phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- identity_sid (unicode) – The SID of the Identity resource to associate with the new phone number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- emergency_status (LocalInstance.EmergencyStatus) – Status determining whether the new phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle calls to the new phone number
- voice_receive_mode (LocalInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
Returns: The created LocalInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance
-
get_page(target_url)[source]¶ Retrieve a specific page of LocalInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of LocalInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalPage
-
list(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Lists LocalInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance]
-
page(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of LocalInstance records from the API. Request is executed immediately
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of LocalInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalPage
-
stream(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Streams LocalInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance]
-
-
class
twilio.rest.api.v2010.account.incoming_phone_number.local.LocalPage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of LocalInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalInstance
-
twilio.rest.api.v2010.account.incoming_phone_number.mobile module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance(version, payload, account_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource-
class
AddressRequirement[source]¶ Bases:
object-
ANY= 'any'¶
-
FOREIGN= 'foreign'¶
-
LOCAL= 'local'¶
-
NONE= 'none'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
address_requirements¶ Returns: Whether the phone number requires an Address registered with Twilio. Return type: MobileInstance.AddressRequirement
-
address_sid¶ Returns: The SID of the Address resource associated with the phone number Return type: unicode
-
api_version¶ Returns: The API version used to start a new TwiML session Return type: unicode
-
bundle_sid¶ Returns: The SID of the Bundle resource associated with number Return type: unicode
-
capabilities¶ Returns: Indicate if a phone can receive calls or messages Return type: unicode
-
date_created¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
emergency_address_sid¶ Returns: The emergency address configuration to use for emergency calling Return type: unicode
-
emergency_status¶ Returns: Whether the phone number is enabled for emergency calling Return type: MobileInstance.EmergencyStatus
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
identity_sid¶ Returns: The SID of the Identity resource associated with number Return type: unicode
-
origin¶ Returns: The phone number’s origin. Can be twilio or hosted. Return type: unicode
-
phone_number¶ Returns: The phone number in E.164 format Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
sms_application_sid¶ Returns: The SID of the application that handles SMS messages sent to the phone number Return type: unicode
-
sms_fallback_method¶ Returns: The HTTP method used with sms_fallback_url Return type: unicode
-
sms_fallback_url¶ Returns: The URL that we call when an error occurs while retrieving or executing the TwiML Return type: unicode
-
sms_method¶ Returns: The HTTP method to use with sms_url Return type: unicode
-
sms_url¶ Returns: The URL we call when the phone number receives an incoming SMS message Return type: unicode
-
status¶ Returns: The status Return type: unicode
-
status_callback¶ Returns: The URL to send status information to your application Return type: unicode
-
status_callback_method¶ Returns: The HTTP method we use to call status_callback Return type: unicode
-
trunk_sid¶ Returns: The SID of the Trunk that handles calls to the phone number Return type: unicode
-
uri¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
voice_application_sid¶ Returns: The SID of the application that handles calls to the phone number Return type: unicode
-
voice_fallback_method¶ Returns: The HTTP method used with voice_fallback_url Return type: unicode
-
voice_fallback_url¶ Returns: The URL we call when an error occurs in TwiML Return type: unicode
-
voice_method¶ Returns: The HTTP method used with the voice_url Return type: unicode
-
voice_receive_mode¶ Returns: The voice_receive_mode Return type: MobileInstance.VoiceReceiveMode
-
voice_url¶ Returns: The URL we call when the phone number receives a call Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileList(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(phone_number, api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, identity_sid=<object object>, address_sid=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, voice_receive_mode=<object object>, bundle_sid=<object object>)[source]¶ Create the MobileInstance
Parameters: - phone_number (unicode) – The phone number to purchase in E.164 format
- api_version (unicode) – The API version to use for incoming calls made to the new phone number
- friendly_name (unicode) – A string to describe the new phone number
- sms_application_sid (unicode) – The SID of the application to handle SMS messages
- sms_fallback_method (unicode) – HTTP method used with sms_fallback_url
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms url
- sms_url (unicode) – The URL we should call when the new phone number receives an incoming SMS message
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the new phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- identity_sid (unicode) – The SID of the Identity resource to associate with the new phone number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- emergency_status (MobileInstance.EmergencyStatus) – Status determining whether the new phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle calls to the new phone number
- voice_receive_mode (MobileInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
Returns: The created MobileInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance
-
get_page(target_url)[source]¶ Retrieve a specific page of MobileInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of MobileInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobilePage
-
list(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Lists MobileInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance]
-
page(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of MobileInstance records from the API. Request is executed immediately
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of MobileInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobilePage
-
stream(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Streams MobileInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance]
-
-
class
twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobilePage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of MobileInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileInstance
-
twilio.rest.api.v2010.account.incoming_phone_number.toll_free module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance(version, payload, account_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource-
class
AddressRequirement[source]¶ Bases:
object-
ANY= 'any'¶
-
FOREIGN= 'foreign'¶
-
LOCAL= 'local'¶
-
NONE= 'none'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
address_requirements¶ Returns: Whether the phone number requires an Address registered with Twilio. Return type: TollFreeInstance.AddressRequirement
-
address_sid¶ Returns: The SID of the Address resource associated with the phone number Return type: unicode
-
api_version¶ Returns: The API version used to start a new TwiML session Return type: unicode
-
bundle_sid¶ Returns: The SID of the Bundle resource associated with number Return type: unicode
-
capabilities¶ Returns: Indicate if a phone can receive calls or messages Return type: unicode
-
date_created¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
emergency_address_sid¶ Returns: The emergency address configuration to use for emergency calling Return type: unicode
-
emergency_status¶ Returns: Whether the phone number is enabled for emergency calling Return type: TollFreeInstance.EmergencyStatus
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
identity_sid¶ Returns: The SID of the Identity resource associated with number Return type: unicode
-
origin¶ Returns: The phone number’s origin. Can be twilio or hosted. Return type: unicode
-
phone_number¶ Returns: The phone number in E.164 format Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
sms_application_sid¶ Returns: The SID of the application that handles SMS messages sent to the phone number Return type: unicode
-
sms_fallback_method¶ Returns: The HTTP method used with sms_fallback_url Return type: unicode
-
sms_fallback_url¶ Returns: The URL that we call when an error occurs while retrieving or executing the TwiML Return type: unicode
-
sms_method¶ Returns: The HTTP method to use with sms_url Return type: unicode
-
sms_url¶ Returns: The URL we call when the phone number receives an incoming SMS message Return type: unicode
-
status¶ Returns: The status Return type: unicode
-
status_callback¶ Returns: The URL to send status information to your application Return type: unicode
-
status_callback_method¶ Returns: The HTTP method we use to call status_callback Return type: unicode
-
trunk_sid¶ Returns: The SID of the Trunk that handles calls to the phone number Return type: unicode
-
uri¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
voice_application_sid¶ Returns: The SID of the application that handles calls to the phone number Return type: unicode
-
voice_fallback_method¶ Returns: The HTTP method used with voice_fallback_url Return type: unicode
-
voice_fallback_url¶ Returns: The URL we call when an error occurs in TwiML Return type: unicode
-
voice_method¶ Returns: The HTTP method used with the voice_url Return type: unicode
-
voice_receive_mode¶ Returns: The voice_receive_mode Return type: TollFreeInstance.VoiceReceiveMode
-
voice_url¶ Returns: The URL we call when the phone number receives a call Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeList(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(phone_number, api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, identity_sid=<object object>, address_sid=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, voice_receive_mode=<object object>, bundle_sid=<object object>)[source]¶ Create the TollFreeInstance
Parameters: - phone_number (unicode) – The phone number to purchase in E.164 format
- api_version (unicode) – The API version to use for incoming calls made to the new phone number
- friendly_name (unicode) – A string to describe the new phone number
- sms_application_sid (unicode) – The SID of the application to handle SMS messages
- sms_fallback_method (unicode) – HTTP method used with sms_fallback_url
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms_url
- sms_url (unicode) – The URL we should call when the new phone number receives an incoming SMS message
- status_callback (unicode) – The URL to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the new phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- identity_sid (unicode) – The SID of the Identity resource to associate with the new phone number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- emergency_status (TollFreeInstance.EmergencyStatus) – Status determining whether the new phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle calls to the new phone number
- voice_receive_mode (TollFreeInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
Returns: The created TollFreeInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance
-
get_page(target_url)[source]¶ Retrieve a specific page of TollFreeInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of TollFreeInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreePage
-
list(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Lists TollFreeInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance]
-
page(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of TollFreeInstance records from the API. Request is executed immediately
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of TollFreeInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreePage
-
stream(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Streams TollFreeInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the resources to read
- phone_number (unicode) – The phone numbers of the resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance]
-
-
class
twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreePage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of TollFreeInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberContext(version, account_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext-
assigned_add_ons¶ Access the assigned_add_ons
Returns: twilio.rest.api.v2010.account.incoming_phone_number.assigned_add_on.AssignedAddOnList Return type: twilio.rest.api.v2010.account.incoming_phone_number.assigned_add_on.AssignedAddOnList
-
delete()[source]¶ Deletes the IncomingPhoneNumberInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the IncomingPhoneNumberInstance
Returns: The fetched IncomingPhoneNumberInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-
update(account_sid=<object object>, api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, voice_receive_mode=<object object>, identity_sid=<object object>, address_sid=<object object>, bundle_sid=<object object>)[source]¶ Update the IncomingPhoneNumberInstance
Parameters: - account_sid (unicode) – The SID of the Account that created the resource to update
- api_version (unicode) – The API version to use for incoming calls made to the phone number
- friendly_name (unicode) – A string to describe the resource
- sms_application_sid (unicode) – Unique string that identifies the application
- sms_fallback_method (unicode) – HTTP method used with sms_fallback_url
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms_url
- sms_url (unicode) – The URL we should call when the phone number receives an incoming SMS message
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- emergency_status (IncomingPhoneNumberInstance.EmergencyStatus) – Whether the phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle phone calls to the phone number
- voice_receive_mode (IncomingPhoneNumberInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- identity_sid (unicode) – Unique string that identifies the identity associated with number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
Returns: The updated IncomingPhoneNumberInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-
-
class
twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance(version, payload, account_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource-
class
AddressRequirement[source]¶ Bases:
object-
ANY= 'any'¶
-
FOREIGN= 'foreign'¶
-
LOCAL= 'local'¶
-
NONE= 'none'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
address_requirements¶ Returns: Whether the phone number requires an Address registered with Twilio. Return type: IncomingPhoneNumberInstance.AddressRequirement
-
address_sid¶ Returns: The SID of the Address resource associated with the phone number Return type: unicode
-
api_version¶ Returns: The API version used to start a new TwiML session Return type: unicode
-
assigned_add_ons¶ Access the assigned_add_ons
Returns: twilio.rest.api.v2010.account.incoming_phone_number.assigned_add_on.AssignedAddOnList Return type: twilio.rest.api.v2010.account.incoming_phone_number.assigned_add_on.AssignedAddOnList
-
bundle_sid¶ Returns: The SID of the Bundle resource associated with number Return type: unicode
-
capabilities¶ Returns: Indicate if a phone can receive calls or messages Return type: unicode
-
date_created¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
delete()[source]¶ Deletes the IncomingPhoneNumberInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
emergency_address_sid¶ Returns: The emergency address configuration to use for emergency calling Return type: unicode
-
emergency_status¶ Returns: Whether the phone number is enabled for emergency calling Return type: IncomingPhoneNumberInstance.EmergencyStatus
-
fetch()[source]¶ Fetch the IncomingPhoneNumberInstance
Returns: The fetched IncomingPhoneNumberInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
identity_sid¶ Returns: The SID of the Identity resource associated with number Return type: unicode
-
origin¶ Returns: The phone number’s origin. Can be twilio or hosted. Return type: unicode
-
phone_number¶ Returns: The phone number in E.164 format Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
sms_application_sid¶ Returns: The SID of the application that handles SMS messages sent to the phone number Return type: unicode
-
sms_fallback_method¶ Returns: The HTTP method used with sms_fallback_url Return type: unicode
-
sms_fallback_url¶ Returns: The URL that we call when an error occurs while retrieving or executing the TwiML Return type: unicode
-
sms_method¶ Returns: The HTTP method to use with sms_url Return type: unicode
-
sms_url¶ Returns: The URL we call when the phone number receives an incoming SMS message Return type: unicode
-
status¶ Returns: The status Return type: unicode
-
status_callback¶ Returns: The URL to send status information to your application Return type: unicode
-
status_callback_method¶ Returns: The HTTP method we use to call status_callback Return type: unicode
-
trunk_sid¶ Returns: The SID of the Trunk that handles calls to the phone number Return type: unicode
-
update(account_sid=<object object>, api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, voice_receive_mode=<object object>, identity_sid=<object object>, address_sid=<object object>, bundle_sid=<object object>)[source]¶ Update the IncomingPhoneNumberInstance
Parameters: - account_sid (unicode) – The SID of the Account that created the resource to update
- api_version (unicode) – The API version to use for incoming calls made to the phone number
- friendly_name (unicode) – A string to describe the resource
- sms_application_sid (unicode) – Unique string that identifies the application
- sms_fallback_method (unicode) – HTTP method used with sms_fallback_url
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms_url
- sms_url (unicode) – The URL we should call when the phone number receives an incoming SMS message
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- emergency_status (IncomingPhoneNumberInstance.EmergencyStatus) – Whether the phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle phone calls to the phone number
- voice_receive_mode (IncomingPhoneNumberInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- identity_sid (unicode) – Unique string that identifies the identity associated with number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
Returns: The updated IncomingPhoneNumberInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-
uri¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
voice_application_sid¶ Returns: The SID of the application that handles calls to the phone number Return type: unicode
-
voice_fallback_method¶ Returns: The HTTP method used with voice_fallback_url Return type: unicode
-
voice_fallback_url¶ Returns: The URL we call when an error occurs in TwiML Return type: unicode
-
voice_method¶ Returns: The HTTP method used with the voice_url Return type: unicode
-
voice_receive_mode¶ Returns: The voice_receive_mode Return type: IncomingPhoneNumberInstance.VoiceReceiveMode
-
voice_url¶ Returns: The URL we call when the phone number receives a call Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberList(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(api_version=<object object>, friendly_name=<object object>, sms_application_sid=<object object>, sms_fallback_method=<object object>, sms_fallback_url=<object object>, sms_method=<object object>, sms_url=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_application_sid=<object object>, voice_caller_id_lookup=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_url=<object object>, emergency_status=<object object>, emergency_address_sid=<object object>, trunk_sid=<object object>, identity_sid=<object object>, address_sid=<object object>, voice_receive_mode=<object object>, bundle_sid=<object object>, phone_number=<object object>, area_code=<object object>)[source]¶ Create the IncomingPhoneNumberInstance
Parameters: - api_version (unicode) – The API version to use for incoming calls made to the new phone number
- friendly_name (unicode) – A string to describe the new phone number
- sms_application_sid (unicode) – The SID of the application to handle SMS messages
- sms_fallback_method (unicode) – HTTP method used with sms_fallback_url
- sms_fallback_url (unicode) – The URL we call when an error occurs while executing TwiML
- sms_method (unicode) – The HTTP method to use with sms url
- sms_url (unicode) – The URL we should call when the new phone number receives an incoming SMS message
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – HTTP method we should use to call status_callback
- voice_application_sid (unicode) – The SID of the application to handle the new phone number
- voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we will call when an error occurs in TwiML
- voice_method (unicode) – The HTTP method used with the voice_url
- voice_url (unicode) – The URL we should call when the phone number receives a call
- emergency_status (IncomingPhoneNumberInstance.EmergencyStatus) – Status determining whether the new phone number is enabled for emergency calling
- emergency_address_sid (unicode) – The emergency address configuration to use for emergency calling
- trunk_sid (unicode) – SID of the trunk to handle calls to the new phone number
- identity_sid (unicode) – The SID of the Identity resource to associate with the new phone number
- address_sid (unicode) – The SID of the Address resource associated with the phone number
- voice_receive_mode (IncomingPhoneNumberInstance.VoiceReceiveMode) – Incoming call type: fax or voice
- bundle_sid (unicode) – The SID of the Bundle resource associated with number
- phone_number (unicode) – The phone number to purchase in E.164 format
- area_code (unicode) – The desired area code for the new phone number
Returns: The created IncomingPhoneNumberInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-
get(sid)[source]¶ Constructs a IncomingPhoneNumberContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberContext Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberContext
-
get_page(target_url)[source]¶ Retrieve a specific page of IncomingPhoneNumberInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of IncomingPhoneNumberInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberPage
-
list(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Lists IncomingPhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the IncomingPhoneNumber resources to read
- phone_number (unicode) – The phone numbers of the IncomingPhoneNumber resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance]
-
local¶ Access the local
Returns: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalList Return type: twilio.rest.api.v2010.account.incoming_phone_number.local.LocalList
-
mobile¶ Access the mobile
Returns: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileList Return type: twilio.rest.api.v2010.account.incoming_phone_number.mobile.MobileList
-
page(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of IncomingPhoneNumberInstance records from the API. Request is executed immediately
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the IncomingPhoneNumber resources to read
- phone_number (unicode) – The phone numbers of the IncomingPhoneNumber resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of IncomingPhoneNumberInstance
Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberPage
-
stream(beta=<object object>, friendly_name=<object object>, phone_number=<object object>, origin=<object object>, limit=None, page_size=None)[source]¶ Streams IncomingPhoneNumberInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - beta (bool) – Whether to include new phone numbers
- friendly_name (unicode) – A string that identifies the IncomingPhoneNumber resources to read
- phone_number (unicode) – The phone numbers of the IncomingPhoneNumber resources to read
- origin (unicode) – Include phone numbers based on their origin. By default, phone numbers of all origin are included.
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance]
-
toll_free¶ Access the toll_free
Returns: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeList Return type: twilio.rest.api.v2010.account.incoming_phone_number.toll_free.TollFreeList
-
-
class
twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberPage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of IncomingPhoneNumberInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance Return type: twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberInstance
-