twilio.rest.api.v2010.account package

Subpackages

Submodules

twilio.rest.api.v2010.account.application module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/application.py:docstring of twilio.rest.api.v2010.account.application, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.application.ApplicationContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the ApplicationInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the ApplicationInstance

Returns:The fetched ApplicationInstance
Return type:twilio.rest.api.v2010.account.application.ApplicationInstance
update(friendly_name=<object object>, api_version=<object object>, voice_url=<object object>, voice_method=<object object>, voice_fallback_url=<object object>, voice_fallback_method=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_caller_id_lookup=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>, sms_status_callback=<object object>, message_status_callback=<object object>)[source]

Update the ApplicationInstance

Parameters:
  • friendly_name (unicode) – A string to describe the resource
  • api_version (unicode) – The API version to use to start a new TwiML session
  • voice_url (unicode) – The URL to call when the phone number receives a call
  • voice_method (unicode) – The HTTP method to use with the voice_url
  • voice_fallback_url (unicode) – The URL to call when a TwiML error occurs
  • voice_fallback_method (unicode) – The HTTP method to use with voice_fallback_url
  • status_callback (unicode) – The URL to send status information to your application
  • status_callback_method (unicode) – The HTTP method to use to call status_callback
  • voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
  • sms_url (unicode) – The URL to call when the phone number receives an incoming SMS message
  • sms_method (unicode) – The HTTP method to use with sms_url
  • sms_fallback_url (unicode) – The URL to call when an error occurs while retrieving or executing the TwiML
  • sms_fallback_method (unicode) – The HTTP method to use with sms_fallback_url
  • sms_status_callback (unicode) – Same as message_status_callback. Deprecated, included for backwards compatibility.
  • message_status_callback (unicode) – The URL to send message status information to your application
Returns:

The updated ApplicationInstance

Return type:

twilio.rest.api.v2010.account.application.ApplicationInstance

class twilio.rest.api.v2010.account.application.ApplicationInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
api_version
Returns:The API version used to start a new TwiML session
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 ApplicationInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the ApplicationInstance

Returns:The fetched ApplicationInstance
Return type:twilio.rest.api.v2010.account.application.ApplicationInstance
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
message_status_callback
Returns:The URL to send message status information to your application
Return type:unicode
sid
Returns:The unique string that identifies the resource
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_status_callback
Returns:The URL to send status information to your application
Return type:unicode
sms_url
Returns:The URL we call when the phone number receives an incoming SMS message
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
update(friendly_name=<object object>, api_version=<object object>, voice_url=<object object>, voice_method=<object object>, voice_fallback_url=<object object>, voice_fallback_method=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_caller_id_lookup=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>, sms_status_callback=<object object>, message_status_callback=<object object>)[source]

Update the ApplicationInstance

Parameters:
  • friendly_name (unicode) – A string to describe the resource
  • api_version (unicode) – The API version to use to start a new TwiML session
  • voice_url (unicode) – The URL to call when the phone number receives a call
  • voice_method (unicode) – The HTTP method to use with the voice_url
  • voice_fallback_url (unicode) – The URL to call when a TwiML error occurs
  • voice_fallback_method (unicode) – The HTTP method to use with voice_fallback_url
  • status_callback (unicode) – The URL to send status information to your application
  • status_callback_method (unicode) – The HTTP method to use to call status_callback
  • voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
  • sms_url (unicode) – The URL to call when the phone number receives an incoming SMS message
  • sms_method (unicode) – The HTTP method to use with sms_url
  • sms_fallback_url (unicode) – The URL to call when an error occurs while retrieving or executing the TwiML
  • sms_fallback_method (unicode) – The HTTP method to use with sms_fallback_url
  • sms_status_callback (unicode) – Same as message_status_callback. Deprecated, included for backwards compatibility.
  • message_status_callback (unicode) – The URL to send message status information to your application
Returns:

The updated ApplicationInstance

Return type:

twilio.rest.api.v2010.account.application.ApplicationInstance

uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
voice_caller_id_lookup
Returns:Whether to lookup the caller’s name
Return type:bool
voice_fallback_method
Returns:The HTTP method used with voice_fallback_url
Return type:unicode
voice_fallback_url
Returns:The URL we call when a TwiML error occurs
Return type:unicode
voice_method
Returns:The HTTP method used with the voice_url
Return type:unicode
voice_url
Returns:The URL we call when the phone number receives a call
Return type:unicode
class twilio.rest.api.v2010.account.application.ApplicationList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(api_version=<object object>, voice_url=<object object>, voice_method=<object object>, voice_fallback_url=<object object>, voice_fallback_method=<object object>, status_callback=<object object>, status_callback_method=<object object>, voice_caller_id_lookup=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>, sms_status_callback=<object object>, message_status_callback=<object object>, friendly_name=<object object>)[source]

Create the ApplicationInstance

Parameters:
  • api_version (unicode) – The API version to use to start a new TwiML session
  • voice_url (unicode) – The URL to call when the phone number receives a call
  • voice_method (unicode) – The HTTP method to use with the voice_url
  • voice_fallback_url (unicode) – The URL to call when a TwiML error occurs
  • voice_fallback_method (unicode) – The HTTP method to use with voice_fallback_url
  • status_callback (unicode) – The URL to send status information to your application
  • status_callback_method (unicode) – The HTTP method to use to call status_callback
  • voice_caller_id_lookup (bool) – Whether to lookup the caller’s name
  • sms_url (unicode) – The URL to call when the phone number receives an incoming SMS message
  • sms_method (unicode) – The HTTP method to use with sms_url
  • sms_fallback_url (unicode) – The URL to call when an error occurs while retrieving or executing the TwiML
  • sms_fallback_method (unicode) – The HTTP method to use with sms_fallback_url
  • sms_status_callback (unicode) – The URL to send status information to your application
  • message_status_callback (unicode) – The URL to send message status information to your application
  • friendly_name (unicode) – A string to describe the new resource
Returns:

The created ApplicationInstance

Return type:

twilio.rest.api.v2010.account.application.ApplicationInstance

get(sid)[source]

Constructs a ApplicationContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.application.ApplicationContext
Return type:twilio.rest.api.v2010.account.application.ApplicationContext
get_page(target_url)[source]

Retrieve a specific page of ApplicationInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ApplicationInstance
Return type:twilio.rest.api.v2010.account.application.ApplicationPage
list(friendly_name=<object object>, limit=None, page_size=None)[source]

Lists ApplicationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • friendly_name (unicode) – The string that identifies the Application resources to read
  • 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.application.ApplicationInstance]

page(friendly_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • friendly_name (unicode) – The string that identifies the Application resources to read
  • 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 ApplicationInstance

Return type:

twilio.rest.api.v2010.account.application.ApplicationPage

stream(friendly_name=<object object>, limit=None, page_size=None)[source]

Streams ApplicationInstance 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:
  • friendly_name (unicode) – The string that identifies the Application resources to read
  • 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.application.ApplicationInstance]

class twilio.rest.api.v2010.account.application.ApplicationPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ApplicationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.application.ApplicationInstance
Return type:twilio.rest.api.v2010.account.application.ApplicationInstance

twilio.rest.api.v2010.account.authorized_connect_app module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/authorized_connect_app.py:docstring of twilio.rest.api.v2010.account.authorized_connect_app, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppContext(version, account_sid, connect_app_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the AuthorizedConnectAppInstance

Returns:The fetched AuthorizedConnectAppInstance
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppInstance
class twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppInstance(version, payload, account_sid, connect_app_sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Permission[source]

Bases: object

GET_ALL = 'get-all'
POST_ALL = 'post-all'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
connect_app_company_name
Returns:The company name set for the Connect App
Return type:unicode
connect_app_description
Returns:A detailed description of the app
Return type:unicode
connect_app_friendly_name
Returns:The name of the Connect App
Return type:unicode
connect_app_homepage_url
Returns:The public URL for the Connect App
Return type:unicode
connect_app_sid
Returns:The SID that we assigned to the Connect App
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
fetch()[source]

Fetch the AuthorizedConnectAppInstance

Returns:The fetched AuthorizedConnectAppInstance
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppInstance
permissions
Returns:Permissions authorized to the app
Return type:list[AuthorizedConnectAppInstance.Permission]
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(connect_app_sid)[source]

Constructs a AuthorizedConnectAppContext

Parameters:connect_app_sid – The SID of the Connect App to fetch
Returns:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppContext
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppContext
get_page(target_url)[source]

Retrieve a specific page of AuthorizedConnectAppInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of AuthorizedConnectAppInstance
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppPage
list(limit=None, page_size=None)[source]

Lists AuthorizedConnectAppInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • 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.authorized_connect_app.AuthorizedConnectAppInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 AuthorizedConnectAppInstance

Return type:

twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppPage

stream(limit=None, page_size=None)[source]

Streams AuthorizedConnectAppInstance 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:
  • 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.authorized_connect_app.AuthorizedConnectAppInstance]

class twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of AuthorizedConnectAppInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppInstance
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppInstance

twilio.rest.api.v2010.account.balance module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/balance.py:docstring of twilio.rest.api.v2010.account.balance, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.balance.BalanceInstance(version, payload, account_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:Account Sid.
Return type:unicode
balance
Returns:Account balance
Return type:unicode
currency
Returns:Currency units
Return type:unicode
class twilio.rest.api.v2010.account.balance.BalanceList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

fetch()[source]

Fetch the BalanceInstance

Returns:The fetched BalanceInstance
Return type:twilio.rest.api.v2010.account.balance.BalanceInstance
class twilio.rest.api.v2010.account.balance.BalancePage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of BalanceInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.balance.BalanceInstance
Return type:twilio.rest.api.v2010.account.balance.BalanceInstance

twilio.rest.api.v2010.account.connect_app module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/connect_app.py:docstring of twilio.rest.api.v2010.account.connect_app, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.connect_app.ConnectAppContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the ConnectAppInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the ConnectAppInstance

Returns:The fetched ConnectAppInstance
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
update(authorize_redirect_url=<object object>, company_name=<object object>, deauthorize_callback_method=<object object>, deauthorize_callback_url=<object object>, description=<object object>, friendly_name=<object object>, homepage_url=<object object>, permissions=<object object>)[source]

Update the ConnectAppInstance

Parameters:
  • authorize_redirect_url (unicode) – The URL to redirect the user to after authorization
  • company_name (unicode) – The company name to set for the Connect App
  • deauthorize_callback_method (unicode) – The HTTP method to use when calling deauthorize_callback_url
  • deauthorize_callback_url (unicode) – The URL to call to de-authorize the Connect App
  • description (unicode) – A description of the Connect App
  • friendly_name (unicode) – A string to describe the resource
  • homepage_url (unicode) – A public URL where users can obtain more information
  • permissions (list[ConnectAppInstance.Permission]) – The set of permissions that your ConnectApp will request
Returns:

The updated ConnectAppInstance

Return type:

twilio.rest.api.v2010.account.connect_app.ConnectAppInstance

class twilio.rest.api.v2010.account.connect_app.ConnectAppInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Permission[source]

Bases: object

GET_ALL = 'get-all'
POST_ALL = 'post-all'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
authorize_redirect_url
Returns:The URL to redirect the user to after authorization
Return type:unicode
company_name
Returns:The company name set for the Connect App
Return type:unicode
deauthorize_callback_method
Returns:The HTTP method we use to call deauthorize_callback_url
Return type:unicode
deauthorize_callback_url
Returns:The URL we call to de-authorize the Connect App
Return type:unicode
delete()[source]

Deletes the ConnectAppInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
description
Returns:The description of the Connect App
Return type:unicode
fetch()[source]

Fetch the ConnectAppInstance

Returns:The fetched ConnectAppInstance
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
homepage_url
Returns:The URL users can obtain more information
Return type:unicode
permissions
Returns:The set of permissions that your ConnectApp requests
Return type:list[ConnectAppInstance.Permission]
sid
Returns:The unique string that identifies the resource
Return type:unicode
update(authorize_redirect_url=<object object>, company_name=<object object>, deauthorize_callback_method=<object object>, deauthorize_callback_url=<object object>, description=<object object>, friendly_name=<object object>, homepage_url=<object object>, permissions=<object object>)[source]

Update the ConnectAppInstance

Parameters:
  • authorize_redirect_url (unicode) – The URL to redirect the user to after authorization
  • company_name (unicode) – The company name to set for the Connect App
  • deauthorize_callback_method (unicode) – The HTTP method to use when calling deauthorize_callback_url
  • deauthorize_callback_url (unicode) – The URL to call to de-authorize the Connect App
  • description (unicode) – A description of the Connect App
  • friendly_name (unicode) – A string to describe the resource
  • homepage_url (unicode) – A public URL where users can obtain more information
  • permissions (list[ConnectAppInstance.Permission]) – The set of permissions that your ConnectApp will request
Returns:

The updated ConnectAppInstance

Return type:

twilio.rest.api.v2010.account.connect_app.ConnectAppInstance

uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.connect_app.ConnectAppList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a ConnectAppContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.connect_app.ConnectAppContext
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppContext
get_page(target_url)[source]

Retrieve a specific page of ConnectAppInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ConnectAppInstance
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppPage
list(limit=None, page_size=None)[source]

Lists ConnectAppInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • 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.connect_app.ConnectAppInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 ConnectAppInstance

Return type:

twilio.rest.api.v2010.account.connect_app.ConnectAppPage

stream(limit=None, page_size=None)[source]

Streams ConnectAppInstance 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:
  • 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.connect_app.ConnectAppInstance]

class twilio.rest.api.v2010.account.connect_app.ConnectAppPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ConnectAppInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.connect_app.ConnectAppInstance
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppInstance

twilio.rest.api.v2010.account.key module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/key.py:docstring of twilio.rest.api.v2010.account.key, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.key.KeyContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the KeyInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the KeyInstance

Returns:The fetched KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyInstance
update(friendly_name=<object object>)[source]

Update the KeyInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The updated KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyInstance
class twilio.rest.api.v2010.account.key.KeyInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 KeyInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the KeyInstance

Returns:The fetched KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyInstance
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
update(friendly_name=<object object>)[source]

Update the KeyInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The updated KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyInstance
class twilio.rest.api.v2010.account.key.KeyList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a KeyContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.key.KeyContext
Return type:twilio.rest.api.v2010.account.key.KeyContext
get_page(target_url)[source]

Retrieve a specific page of KeyInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyPage
list(limit=None, page_size=None)[source]

Lists KeyInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • 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.key.KeyInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 KeyInstance

Return type:

twilio.rest.api.v2010.account.key.KeyPage

stream(limit=None, page_size=None)[source]

Streams KeyInstance 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:
  • 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.key.KeyInstance]

class twilio.rest.api.v2010.account.key.KeyPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of KeyInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.key.KeyInstance
Return type:twilio.rest.api.v2010.account.key.KeyInstance

twilio.rest.api.v2010.account.new_key module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/new_key.py:docstring of twilio.rest.api.v2010.account.new_key, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.new_key.NewKeyInstance(version, payload, account_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
secret
Returns:The secret your application uses to sign Access Tokens and to authenticate to the REST API.
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
class twilio.rest.api.v2010.account.new_key.NewKeyList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name=<object object>)[source]

Create the NewKeyInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The created NewKeyInstance
Return type:twilio.rest.api.v2010.account.new_key.NewKeyInstance
class twilio.rest.api.v2010.account.new_key.NewKeyPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of NewKeyInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.new_key.NewKeyInstance
Return type:twilio.rest.api.v2010.account.new_key.NewKeyInstance

twilio.rest.api.v2010.account.new_signing_key module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/new_signing_key.py:docstring of twilio.rest.api.v2010.account.new_signing_key, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyInstance(version, payload, account_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
secret
Returns:The secret your application uses to sign Access Tokens and to authenticate to the REST API.
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
class twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name=<object object>)[source]

Create the NewSigningKeyInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The created NewSigningKeyInstance
Return type:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyInstance
class twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of NewSigningKeyInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyInstance
Return type:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyInstance

twilio.rest.api.v2010.account.notification module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/notification.py:docstring of twilio.rest.api.v2010.account.notification, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.notification.NotificationContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the NotificationInstance

Returns:The fetched NotificationInstance
Return type:twilio.rest.api.v2010.account.notification.NotificationInstance
class twilio.rest.api.v2010.account.notification.NotificationInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
api_version
Returns:The API version used to generate the notification
Return type:unicode
call_sid
Returns:The SID of the Call the resource is associated with
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
error_code
Returns:A unique error code corresponding to the notification
Return type:unicode
fetch()[source]

Fetch the NotificationInstance

Returns:The fetched NotificationInstance
Return type:twilio.rest.api.v2010.account.notification.NotificationInstance
log
Returns:An integer log level
Return type:unicode
message_date
Returns:The date the notification was generated
Return type:datetime
message_text
Returns:The text of the notification
Return type:unicode
more_info
Returns:A URL for more information about the error code
Return type:unicode
request_method
Returns:HTTP method used with the request url
Return type:unicode
request_url
Returns:URL of the resource that generated the notification
Return type:unicode
request_variables
Returns:Twilio-generated HTTP variables sent to the server
Return type:unicode
response_body
Returns:The HTTP body returned by your server
Return type:unicode
response_headers
Returns:The HTTP headers returned by your server
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.notification.NotificationList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a NotificationContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.notification.NotificationContext
Return type:twilio.rest.api.v2010.account.notification.NotificationContext
get_page(target_url)[source]

Retrieve a specific page of NotificationInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of NotificationInstance
Return type:twilio.rest.api.v2010.account.notification.NotificationPage
list(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, limit=None, page_size=None)[source]

Lists NotificationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • log (unicode) – Filter by log level
  • message_date_before (date) – Filter by date
  • message_date (date) – Filter by date
  • message_date_after (date) – Filter by date
  • 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.notification.NotificationInstance]

page(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • log (unicode) – Filter by log level
  • message_date_before (date) – Filter by date
  • message_date (date) – Filter by date
  • message_date_after (date) – Filter by date
  • 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 NotificationInstance

Return type:

twilio.rest.api.v2010.account.notification.NotificationPage

stream(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, limit=None, page_size=None)[source]

Streams NotificationInstance 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:
  • log (unicode) – Filter by log level
  • message_date_before (date) – Filter by date
  • message_date (date) – Filter by date
  • message_date_after (date) – Filter by date
  • 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.notification.NotificationInstance]

class twilio.rest.api.v2010.account.notification.NotificationPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of NotificationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.notification.NotificationInstance
Return type:twilio.rest.api.v2010.account.notification.NotificationInstance

twilio.rest.api.v2010.account.outgoing_caller_id module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/outgoing_caller_id.py:docstring of twilio.rest.api.v2010.account.outgoing_caller_id, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the OutgoingCallerIdInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the OutgoingCallerIdInstance

Returns:The fetched OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance
update(friendly_name=<object object>)[source]

Update the OutgoingCallerIdInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The updated OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance
class twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
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 OutgoingCallerIdInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the OutgoingCallerIdInstance

Returns:The fetched OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance
friendly_name
Returns:The string that you assigned to describe the resource
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
update(friendly_name=<object object>)[source]

Update the OutgoingCallerIdInstance

Parameters:friendly_name (unicode) – A string to describe the resource
Returns:The updated OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a OutgoingCallerIdContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdContext
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdContext
get_page(target_url)[source]

Retrieve a specific page of OutgoingCallerIdInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdPage
list(phone_number=<object object>, friendly_name=<object object>, limit=None, page_size=None)[source]

Lists OutgoingCallerIdInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • phone_number (unicode) – The phone number of the OutgoingCallerId resources to read
  • friendly_name (unicode) – The string that identifies the OutgoingCallerId resources to read
  • 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.outgoing_caller_id.OutgoingCallerIdInstance]

page(phone_number=<object object>, friendly_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • phone_number (unicode) – The phone number of the OutgoingCallerId resources to read
  • friendly_name (unicode) – The string that identifies the OutgoingCallerId resources to read
  • 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 OutgoingCallerIdInstance

Return type:

twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdPage

stream(phone_number=<object object>, friendly_name=<object object>, limit=None, page_size=None)[source]

Streams OutgoingCallerIdInstance 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:
  • phone_number (unicode) – The phone number of the OutgoingCallerId resources to read
  • friendly_name (unicode) – The string that identifies the OutgoingCallerId resources to read
  • 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.outgoing_caller_id.OutgoingCallerIdInstance]

class twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of OutgoingCallerIdInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdInstance

twilio.rest.api.v2010.account.short_code module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/short_code.py:docstring of twilio.rest.api.v2010.account.short_code, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.short_code.ShortCodeContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the ShortCodeInstance

Returns:The fetched ShortCodeInstance
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeInstance
update(friendly_name=<object object>, api_version=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>)[source]

Update the ShortCodeInstance

Parameters:
  • friendly_name (unicode) – A string to describe this resource
  • api_version (unicode) – The API version to use to start a new TwiML session
  • sms_url (unicode) – URL Twilio will request when receiving an SMS
  • sms_method (unicode) – HTTP method to use when requesting the sms url
  • sms_fallback_url (unicode) – URL Twilio will request if an error occurs in executing TwiML
  • sms_fallback_method (unicode) – HTTP method Twilio will use with sms_fallback_url
Returns:

The updated ShortCodeInstance

Return type:

twilio.rest.api.v2010.account.short_code.ShortCodeInstance

class twilio.rest.api.v2010.account.short_code.ShortCodeInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created this resource
Return type:unicode
api_version
Returns:The API version used to start a new TwiML session
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT that this resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT that this resource was last updated
Return type:datetime
fetch()[source]

Fetch the ShortCodeInstance

Returns:The fetched ShortCodeInstance
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeInstance
friendly_name
Returns:A string that you assigned to describe this resource
Return type:unicode
short_code
Returns:The short code. e.g., 894546.
Return type:unicode
sid
Returns:The unique string that identifies this resource
Return type:unicode
sms_fallback_method
Returns:HTTP method we use to call the sms_fallback_url
Return type:unicode
sms_fallback_url
Returns:URL Twilio will request if an error occurs in executing TwiML
Return type:unicode
sms_method
Returns:HTTP method to use when requesting the sms url
Return type:unicode
sms_url
Returns:URL we call when receiving an incoming SMS message to this short code
Return type:unicode
update(friendly_name=<object object>, api_version=<object object>, sms_url=<object object>, sms_method=<object object>, sms_fallback_url=<object object>, sms_fallback_method=<object object>)[source]

Update the ShortCodeInstance

Parameters:
  • friendly_name (unicode) – A string to describe this resource
  • api_version (unicode) – The API version to use to start a new TwiML session
  • sms_url (unicode) – URL Twilio will request when receiving an SMS
  • sms_method (unicode) – HTTP method to use when requesting the sms url
  • sms_fallback_url (unicode) – URL Twilio will request if an error occurs in executing TwiML
  • sms_fallback_method (unicode) – HTTP method Twilio will use with sms_fallback_url
Returns:

The updated ShortCodeInstance

Return type:

twilio.rest.api.v2010.account.short_code.ShortCodeInstance

uri
Returns:The URI of this resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.short_code.ShortCodeList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a ShortCodeContext

Parameters:sid – The unique string that identifies this resource
Returns:twilio.rest.api.v2010.account.short_code.ShortCodeContext
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeContext
get_page(target_url)[source]

Retrieve a specific page of ShortCodeInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ShortCodeInstance
Return type:twilio.rest.api.v2010.account.short_code.ShortCodePage
list(friendly_name=<object object>, short_code=<object object>, limit=None, page_size=None)[source]

Lists ShortCodeInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • friendly_name (unicode) – The string that identifies the ShortCode resources to read
  • short_code (unicode) – Filter by ShortCode
  • 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.short_code.ShortCodeInstance]

page(friendly_name=<object object>, short_code=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • friendly_name (unicode) – The string that identifies the ShortCode resources to read
  • short_code (unicode) – Filter by ShortCode
  • 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 ShortCodeInstance

Return type:

twilio.rest.api.v2010.account.short_code.ShortCodePage

stream(friendly_name=<object object>, short_code=<object object>, limit=None, page_size=None)[source]

Streams ShortCodeInstance 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:
  • friendly_name (unicode) – The string that identifies the ShortCode resources to read
  • short_code (unicode) – Filter by ShortCode
  • 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.short_code.ShortCodeInstance]

class twilio.rest.api.v2010.account.short_code.ShortCodePage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ShortCodeInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.short_code.ShortCodeInstance
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeInstance

twilio.rest.api.v2010.account.signing_key module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/signing_key.py:docstring of twilio.rest.api.v2010.account.signing_key, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.signing_key.SigningKeyContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the SigningKeyInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SigningKeyInstance

Returns:The fetched SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance
update(friendly_name=<object object>)[source]

Update the SigningKeyInstance

Parameters:friendly_name (unicode) – The friendly_name
Returns:The updated SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance
class twilio.rest.api.v2010.account.signing_key.SigningKeyInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

date_created
Returns:The date_created
Return type:datetime
date_updated
Returns:The date_updated
Return type:datetime
delete()[source]

Deletes the SigningKeyInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the SigningKeyInstance

Returns:The fetched SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance
friendly_name
Returns:The friendly_name
Return type:unicode
sid
Returns:The sid
Return type:unicode
update(friendly_name=<object object>)[source]

Update the SigningKeyInstance

Parameters:friendly_name (unicode) – The friendly_name
Returns:The updated SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance
class twilio.rest.api.v2010.account.signing_key.SigningKeyList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a SigningKeyContext

Parameters:sid – The sid
Returns:twilio.rest.api.v2010.account.signing_key.SigningKeyContext
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyContext
get_page(target_url)[source]

Retrieve a specific page of SigningKeyInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyPage
list(limit=None, page_size=None)[source]

Lists SigningKeyInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • 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.signing_key.SigningKeyInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 SigningKeyInstance

Return type:

twilio.rest.api.v2010.account.signing_key.SigningKeyPage

stream(limit=None, page_size=None)[source]

Streams SigningKeyInstance 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:
  • 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.signing_key.SigningKeyInstance]

class twilio.rest.api.v2010.account.signing_key.SigningKeyPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SigningKeyInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyInstance

twilio.rest.api.v2010.account.token module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/token.py:docstring of twilio.rest.api.v2010.account.token, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.token.TokenInstance(version, payload, account_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
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
ice_servers
Returns:An array representing the ephemeral credentials
Return type:list[unicode]
password
Returns:The temporary password used for authenticating
Return type:unicode
ttl
Returns:The duration in seconds the credentials are valid
Return type:unicode
username
Returns:The temporary username that uniquely identifies a Token
Return type:unicode
class twilio.rest.api.v2010.account.token.TokenList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(ttl=<object object>)[source]

Create the TokenInstance

Parameters:ttl (unicode) – The duration in seconds the credentials are valid
Returns:The created TokenInstance
Return type:twilio.rest.api.v2010.account.token.TokenInstance
class twilio.rest.api.v2010.account.token.TokenPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of TokenInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.token.TokenInstance
Return type:twilio.rest.api.v2010.account.token.TokenInstance

twilio.rest.api.v2010.account.transcription module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/transcription.py:docstring of twilio.rest.api.v2010.account.transcription, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.transcription.TranscriptionContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the TranscriptionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the TranscriptionInstance

Returns:The fetched TranscriptionInstance
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionInstance
class twilio.rest.api.v2010.account.transcription.TranscriptionInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

COMPLETED = 'completed'
FAILED = 'failed'
IN_PROGRESS = 'in-progress'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
api_version
Returns:The API version used to create the transcription
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 TranscriptionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
duration
Returns:The duration of the transcribed audio in seconds.
Return type:unicode
fetch()[source]

Fetch the TranscriptionInstance

Returns:The fetched TranscriptionInstance
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionInstance
price
Returns:The charge for the transcription
Return type:unicode
price_unit
Returns:The currency in which price is measured
Return type:unicode
recording_sid
Returns:The SID that identifies the transcription’s recording
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the transcription
Return type:TranscriptionInstance.Status
transcription_text
Returns:The text content of the transcription.
Return type:unicode
type
Returns:The transcription type
Return type:unicode
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.transcription.TranscriptionList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a TranscriptionContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.transcription.TranscriptionContext
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionContext
get_page(target_url)[source]

Retrieve a specific page of TranscriptionInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of TranscriptionInstance
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionPage
list(limit=None, page_size=None)[source]

Lists TranscriptionInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • 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.transcription.TranscriptionInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 TranscriptionInstance

Return type:

twilio.rest.api.v2010.account.transcription.TranscriptionPage

stream(limit=None, page_size=None)[source]

Streams TranscriptionInstance 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:
  • 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.transcription.TranscriptionInstance]

class twilio.rest.api.v2010.account.transcription.TranscriptionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of TranscriptionInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.transcription.TranscriptionInstance
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionInstance

twilio.rest.api.v2010.account.validation_request module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/validation_request.py:docstring of twilio.rest.api.v2010.account.validation_request, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.validation_request.ValidationRequestInstance(version, payload, account_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
call_sid
Returns:The SID of the Call the resource is associated with
Return type:unicode
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
phone_number
Returns:The phone number to verify in E.164 format
Return type:unicode
validation_code
Returns:The 6 digit validation code that someone must enter to validate the Caller ID when phone_number is called
Return type:unicode
class twilio.rest.api.v2010.account.validation_request.ValidationRequestList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(phone_number, friendly_name=<object object>, call_delay=<object object>, extension=<object object>, status_callback=<object object>, status_callback_method=<object object>)[source]

Create the ValidationRequestInstance

Parameters:
  • phone_number (unicode) – The phone number to verify in E.164 format
  • friendly_name (unicode) – A string to describe the resource
  • call_delay (unicode) – The number of seconds to delay before initiating the verification call
  • extension (unicode) – The digits to dial after connecting the verification call
  • 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
Returns:

The created ValidationRequestInstance

Return type:

twilio.rest.api.v2010.account.validation_request.ValidationRequestInstance

class twilio.rest.api.v2010.account.validation_request.ValidationRequestPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ValidationRequestInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.validation_request.ValidationRequestInstance
Return type:twilio.rest.api.v2010.account.validation_request.ValidationRequestInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/__init__.py:docstring of twilio.rest.api.v2010.account, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.AccountContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

addresses

Access the addresses

Returns:twilio.rest.api.v2010.account.address.AddressList
Return type:twilio.rest.api.v2010.account.address.AddressList
applications

Access the applications

Returns:twilio.rest.api.v2010.account.application.ApplicationList
Return type:twilio.rest.api.v2010.account.application.ApplicationList
authorized_connect_apps

Access the authorized_connect_apps

Returns:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppList
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppList
available_phone_numbers

Access the available_phone_numbers

Returns:twilio.rest.api.v2010.account.available_phone_number.AvailablePhoneNumberCountryList
Return type:twilio.rest.api.v2010.account.available_phone_number.AvailablePhoneNumberCountryList
balance

Access the balance

Returns:twilio.rest.api.v2010.account.balance.BalanceList
Return type:twilio.rest.api.v2010.account.balance.BalanceList
calls

Access the calls

Returns:twilio.rest.api.v2010.account.call.CallList
Return type:twilio.rest.api.v2010.account.call.CallList
conferences

Access the conferences

Returns:twilio.rest.api.v2010.account.conference.ConferenceList
Return type:twilio.rest.api.v2010.account.conference.ConferenceList
connect_apps

Access the connect_apps

Returns:twilio.rest.api.v2010.account.connect_app.ConnectAppList
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppList
fetch()[source]

Fetch the AccountInstance

Returns:The fetched AccountInstance
Return type:twilio.rest.api.v2010.account.AccountInstance
incoming_phone_numbers

Access the incoming_phone_numbers

Returns:twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberList
Return type:twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberList
keys

Access the keys

Returns:twilio.rest.api.v2010.account.key.KeyList
Return type:twilio.rest.api.v2010.account.key.KeyList
messages

Access the messages

Returns:twilio.rest.api.v2010.account.message.MessageList
Return type:twilio.rest.api.v2010.account.message.MessageList
new_keys

Access the new_keys

Returns:twilio.rest.api.v2010.account.new_key.NewKeyList
Return type:twilio.rest.api.v2010.account.new_key.NewKeyList
new_signing_keys

Access the new_signing_keys

Returns:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyList
Return type:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyList
notifications

Access the notifications

Returns:twilio.rest.api.v2010.account.notification.NotificationList
Return type:twilio.rest.api.v2010.account.notification.NotificationList
outgoing_caller_ids

Access the outgoing_caller_ids

Returns:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdList
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdList
queues

Access the queues

Returns:twilio.rest.api.v2010.account.queue.QueueList
Return type:twilio.rest.api.v2010.account.queue.QueueList
recordings

Access the recordings

Returns:twilio.rest.api.v2010.account.recording.RecordingList
Return type:twilio.rest.api.v2010.account.recording.RecordingList
short_codes

Access the short_codes

Returns:twilio.rest.api.v2010.account.short_code.ShortCodeList
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeList
signing_keys

Access the signing_keys

Returns:twilio.rest.api.v2010.account.signing_key.SigningKeyList
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyList
sip

Access the sip

Returns:twilio.rest.api.v2010.account.sip.SipList
Return type:twilio.rest.api.v2010.account.sip.SipList
tokens

Access the tokens

Returns:twilio.rest.api.v2010.account.token.TokenList
Return type:twilio.rest.api.v2010.account.token.TokenList
transcriptions

Access the transcriptions

Returns:twilio.rest.api.v2010.account.transcription.TranscriptionList
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionList
update(friendly_name=<object object>, status=<object object>)[source]

Update the AccountInstance

Parameters:
  • friendly_name (unicode) – FriendlyName to update
  • status (AccountInstance.Status) – Status to update the Account with
Returns:

The updated AccountInstance

Return type:

twilio.rest.api.v2010.account.AccountInstance

usage

Access the usage

Returns:twilio.rest.api.v2010.account.usage.UsageList
Return type:twilio.rest.api.v2010.account.usage.UsageList
validation_requests

Access the validation_requests

Returns:twilio.rest.api.v2010.account.validation_request.ValidationRequestList
Return type:twilio.rest.api.v2010.account.validation_request.ValidationRequestList
class twilio.rest.api.v2010.account.AccountInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

ACTIVE = 'active'
CLOSED = 'closed'
SUSPENDED = 'suspended'
class Type[source]

Bases: object

FULL = 'Full'
TRIAL = 'Trial'
addresses

Access the addresses

Returns:twilio.rest.api.v2010.account.address.AddressList
Return type:twilio.rest.api.v2010.account.address.AddressList
applications

Access the applications

Returns:twilio.rest.api.v2010.account.application.ApplicationList
Return type:twilio.rest.api.v2010.account.application.ApplicationList
auth_token
Returns:The authorization token for this account
Return type:unicode
authorized_connect_apps

Access the authorized_connect_apps

Returns:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppList
Return type:twilio.rest.api.v2010.account.authorized_connect_app.AuthorizedConnectAppList
available_phone_numbers

Access the available_phone_numbers

Returns:twilio.rest.api.v2010.account.available_phone_number.AvailablePhoneNumberCountryList
Return type:twilio.rest.api.v2010.account.available_phone_number.AvailablePhoneNumberCountryList
balance

Access the balance

Returns:twilio.rest.api.v2010.account.balance.BalanceList
Return type:twilio.rest.api.v2010.account.balance.BalanceList
calls

Access the calls

Returns:twilio.rest.api.v2010.account.call.CallList
Return type:twilio.rest.api.v2010.account.call.CallList
conferences

Access the conferences

Returns:twilio.rest.api.v2010.account.conference.ConferenceList
Return type:twilio.rest.api.v2010.account.conference.ConferenceList
connect_apps

Access the connect_apps

Returns:twilio.rest.api.v2010.account.connect_app.ConnectAppList
Return type:twilio.rest.api.v2010.account.connect_app.ConnectAppList
date_created
Returns:The date this account was created
Return type:datetime
date_updated
Returns:The date this account was last updated
Return type:datetime
fetch()[source]

Fetch the AccountInstance

Returns:The fetched AccountInstance
Return type:twilio.rest.api.v2010.account.AccountInstance
friendly_name
Returns:A human readable description of this account
Return type:unicode
incoming_phone_numbers

Access the incoming_phone_numbers

Returns:twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberList
Return type:twilio.rest.api.v2010.account.incoming_phone_number.IncomingPhoneNumberList
keys

Access the keys

Returns:twilio.rest.api.v2010.account.key.KeyList
Return type:twilio.rest.api.v2010.account.key.KeyList
messages

Access the messages

Returns:twilio.rest.api.v2010.account.message.MessageList
Return type:twilio.rest.api.v2010.account.message.MessageList
new_keys

Access the new_keys

Returns:twilio.rest.api.v2010.account.new_key.NewKeyList
Return type:twilio.rest.api.v2010.account.new_key.NewKeyList
new_signing_keys

Access the new_signing_keys

Returns:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyList
Return type:twilio.rest.api.v2010.account.new_signing_key.NewSigningKeyList
notifications

Access the notifications

Returns:twilio.rest.api.v2010.account.notification.NotificationList
Return type:twilio.rest.api.v2010.account.notification.NotificationList
outgoing_caller_ids

Access the outgoing_caller_ids

Returns:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdList
Return type:twilio.rest.api.v2010.account.outgoing_caller_id.OutgoingCallerIdList
owner_account_sid
Returns:The unique 34 character id representing the parent of this account
Return type:unicode
queues

Access the queues

Returns:twilio.rest.api.v2010.account.queue.QueueList
Return type:twilio.rest.api.v2010.account.queue.QueueList
recordings

Access the recordings

Returns:twilio.rest.api.v2010.account.recording.RecordingList
Return type:twilio.rest.api.v2010.account.recording.RecordingList
short_codes

Access the short_codes

Returns:twilio.rest.api.v2010.account.short_code.ShortCodeList
Return type:twilio.rest.api.v2010.account.short_code.ShortCodeList
sid
Returns:A 34 character string that uniquely identifies this resource.
Return type:unicode
signing_keys

Access the signing_keys

Returns:twilio.rest.api.v2010.account.signing_key.SigningKeyList
Return type:twilio.rest.api.v2010.account.signing_key.SigningKeyList
sip

Access the sip

Returns:twilio.rest.api.v2010.account.sip.SipList
Return type:twilio.rest.api.v2010.account.sip.SipList
status
Returns:The status of this account
Return type:AccountInstance.Status
subresource_uris
Returns:Account Instance Subresources
Return type:unicode
tokens

Access the tokens

Returns:twilio.rest.api.v2010.account.token.TokenList
Return type:twilio.rest.api.v2010.account.token.TokenList
transcriptions

Access the transcriptions

Returns:twilio.rest.api.v2010.account.transcription.TranscriptionList
Return type:twilio.rest.api.v2010.account.transcription.TranscriptionList
type
Returns:The type of this account
Return type:AccountInstance.Type
update(friendly_name=<object object>, status=<object object>)[source]

Update the AccountInstance

Parameters:
  • friendly_name (unicode) – FriendlyName to update
  • status (AccountInstance.Status) – Status to update the Account with
Returns:

The updated AccountInstance

Return type:

twilio.rest.api.v2010.account.AccountInstance

uri
Returns:The URI for this resource, relative to https://api.twilio.com
Return type:unicode
usage

Access the usage

Returns:twilio.rest.api.v2010.account.usage.UsageList
Return type:twilio.rest.api.v2010.account.usage.UsageList
validation_requests

Access the validation_requests

Returns:twilio.rest.api.v2010.account.validation_request.ValidationRequestList
Return type:twilio.rest.api.v2010.account.validation_request.ValidationRequestList
class twilio.rest.api.v2010.account.AccountList(version)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name=<object object>)[source]

Create the AccountInstance

Parameters:friendly_name (unicode) – A human readable description of the account
Returns:The created AccountInstance
Return type:twilio.rest.api.v2010.account.AccountInstance
get(sid)[source]

Constructs a AccountContext

Parameters:sid – Fetch by unique Account Sid
Returns:twilio.rest.api.v2010.account.AccountContext
Return type:twilio.rest.api.v2010.account.AccountContext
get_page(target_url)[source]

Retrieve a specific page of AccountInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of AccountInstance
Return type:twilio.rest.api.v2010.account.AccountPage
list(friendly_name=<object object>, status=<object object>, limit=None, page_size=None)[source]

Lists AccountInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • friendly_name (unicode) – FriendlyName to filter on
  • status (AccountInstance.Status) – Status to filter on
  • 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.AccountInstance]

page(friendly_name=<object object>, status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • friendly_name (unicode) – FriendlyName to filter on
  • status (AccountInstance.Status) – Status to filter on
  • 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 AccountInstance

Return type:

twilio.rest.api.v2010.account.AccountPage

stream(friendly_name=<object object>, status=<object object>, limit=None, page_size=None)[source]

Streams AccountInstance 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:
  • friendly_name (unicode) – FriendlyName to filter on
  • status (AccountInstance.Status) – Status to filter on
  • 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.AccountInstance]

class twilio.rest.api.v2010.account.AccountPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of AccountInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.AccountInstance
Return type:twilio.rest.api.v2010.account.AccountInstance