twilio.rest.api.v2010.account.sip.domain package¶
Subpackages¶
Submodules¶
twilio.rest.api.v2010.account.sip.domain.credential_list_mapping module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.
CredentialListMappingContext
(version, account_sid, domain_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CredentialListMappingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CredentialListMappingInstance
Returns: The fetched CredentialListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance
-
-
class
twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.
CredentialListMappingInstance
(version, payload, account_sid, domain_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The unique id of the Account that is responsible for this resource. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created, given as GMT in RFC 2822 format. Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated, given as GMT in RFC 2822 format. Return type: datetime
-
delete
()[source]¶ Deletes the CredentialListMappingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
domain_sid
¶ Returns: The unique string that identifies the SipDomain resource. Return type: unicode
-
fetch
()[source]¶ Fetch the CredentialListMappingInstance
Returns: The fetched CredentialListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance
-
friendly_name
¶ Returns: A human readable descriptive text for this resource, up to 64 characters long. Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
uri
¶ Returns: The URI for this resource, relative to https://api.twilio.com Return type: unicode
-
-
class
twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.
CredentialListMappingList
(version, account_sid, domain_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(credential_list_sid)[source]¶ Create the CredentialListMappingInstance
Parameters: credential_list_sid (unicode) – A string that identifies the CredentialList resource to map to the SIP domain Returns: The created CredentialListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance
-
get
(sid)[source]¶ Constructs a CredentialListMappingContext
Parameters: sid – A string that identifies the resource to fetch Returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CredentialListMappingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CredentialListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage
-
list
(limit=None, page_size=None)[source]¶ Lists CredentialListMappingInstance 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.sip.domain.credential_list_mapping.CredentialListMappingInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CredentialListMappingInstance records from the API. Request is executed immediately
Parameters: Returns: Page of CredentialListMappingInstance
Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage
-
stream
(limit=None, page_size=None)[source]¶ Streams CredentialListMappingInstance 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.sip.domain.credential_list_mapping.CredentialListMappingInstance]
-
-
class
twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.
CredentialListMappingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CredentialListMappingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance
-
twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.
IpAccessControlListMappingContext
(version, account_sid, domain_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the IpAccessControlListMappingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the IpAccessControlListMappingInstance
Returns: The fetched IpAccessControlListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance
-
-
class
twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.
IpAccessControlListMappingInstance
(version, payload, account_sid, domain_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The unique id of the Account that is responsible for this resource. Return type: unicode
-
date_created
¶ Returns: The date that this resource was created, given as GMT in RFC 2822 format. Return type: datetime
-
date_updated
¶ Returns: The date that this resource was last updated, given as GMT in RFC 2822 format. Return type: datetime
-
delete
()[source]¶ Deletes the IpAccessControlListMappingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
domain_sid
¶ Returns: The unique string that identifies the SipDomain resource. Return type: unicode
-
fetch
()[source]¶ Fetch the IpAccessControlListMappingInstance
Returns: The fetched IpAccessControlListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance
-
friendly_name
¶ Returns: A human readable descriptive text for this resource, up to 64 characters long. Return type: unicode
-
sid
¶ Returns: A 34 character string that uniquely identifies this resource. Return type: unicode
-
uri
¶ Returns: The URI for this resource, relative to https://api.twilio.com Return type: unicode
-
-
class
twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.
IpAccessControlListMappingList
(version, account_sid, domain_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(ip_access_control_list_sid)[source]¶ Create the IpAccessControlListMappingInstance
Parameters: ip_access_control_list_sid (unicode) – The unique id of the IP access control list to map to the SIP domain Returns: The created IpAccessControlListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance
-
get
(sid)[source]¶ Constructs a IpAccessControlListMappingContext
Parameters: sid – A 34 character string that uniquely identifies the resource to fetch. Returns: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingContext Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of IpAccessControlListMappingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of IpAccessControlListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingPage
-
list
(limit=None, page_size=None)[source]¶ Lists IpAccessControlListMappingInstance 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.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of IpAccessControlListMappingInstance records from the API. Request is executed immediately
Parameters: Returns: Page of IpAccessControlListMappingInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams IpAccessControlListMappingInstance 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.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance]
-
-
class
twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.
IpAccessControlListMappingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of IpAccessControlListMappingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.sip.domain.
DomainContext
(version, account_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
auth
¶ Access the auth
Returns: twilio.rest.api.v2010.account.sip.domain.auth_types.AuthTypesList Return type: twilio.rest.api.v2010.account.sip.domain.auth_types.AuthTypesList
-
credential_list_mappings
¶ Access the credential_list_mappings
Returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList
-
delete
()[source]¶ Deletes the DomainInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the DomainInstance
Returns: The fetched DomainInstance Return type: twilio.rest.api.v2010.account.sip.domain.DomainInstance
-
ip_access_control_list_mappings
¶ Access the ip_access_control_list_mappings
Returns: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingList Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingList
-
update
(friendly_name=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_status_callback_method=<object object>, voice_status_callback_url=<object object>, voice_url=<object object>, sip_registration=<object object>, domain_name=<object object>, emergency_calling_enabled=<object object>, secure=<object object>, byoc_trunk_sid=<object object>, emergency_caller_sid=<object object>)[source]¶ Update the DomainInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we should call when an error occurs in executing TwiML
- voice_method (unicode) – The HTTP method we should use with voice_url
- voice_status_callback_method (unicode) – The HTTP method we should use to call voice_status_callback_url
- voice_status_callback_url (unicode) – The URL that we should call to pass status updates
- voice_url (unicode) – The URL we should call when receiving a call
- sip_registration (bool) – Whether SIP registration is allowed
- domain_name (unicode) – The unique address on Twilio to route SIP traffic
- emergency_calling_enabled (bool) – Whether emergency calling is enabled for the domain.
- secure (bool) – Whether secure SIP is enabled for the domain
- byoc_trunk_sid (unicode) – The SID of the BYOC Trunk resource.
- emergency_caller_sid (unicode) – Whether an emergency caller sid is configured for the domain.
Returns: The updated DomainInstance
Return type:
-
-
class
twilio.rest.api.v2010.account.sip.domain.
DomainInstance
(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 process the call Return type: unicode
-
auth
¶ Access the auth
Returns: twilio.rest.api.v2010.account.sip.domain.auth_types.AuthTypesList Return type: twilio.rest.api.v2010.account.sip.domain.auth_types.AuthTypesList
-
auth_type
¶ Returns: The types of authentication mapped to the domain Return type: unicode
-
byoc_trunk_sid
¶ Returns: The SID of the BYOC Trunk resource. Return type: unicode
-
credential_list_mappings
¶ Access the credential_list_mappings
Returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList Return type: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList
-
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 DomainInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
domain_name
¶ Returns: The unique address on Twilio to route SIP traffic Return type: unicode
-
emergency_caller_sid
¶ Returns: Whether an emergency caller sid is configured for the domain. Return type: unicode
-
emergency_calling_enabled
¶ Returns: Whether emergency calling is enabled for the domain. Return type: bool
-
fetch
()[source]¶ Fetch the DomainInstance
Returns: The fetched DomainInstance Return type: twilio.rest.api.v2010.account.sip.domain.DomainInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
ip_access_control_list_mappings
¶ Access the ip_access_control_list_mappings
Returns: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingList Return type: twilio.rest.api.v2010.account.sip.domain.ip_access_control_list_mapping.IpAccessControlListMappingList
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
subresource_uris
¶ Returns: A list mapping resources associated with the SIP Domain resource Return type: unicode
-
update
(friendly_name=<object object>, voice_fallback_method=<object object>, voice_fallback_url=<object object>, voice_method=<object object>, voice_status_callback_method=<object object>, voice_status_callback_url=<object object>, voice_url=<object object>, sip_registration=<object object>, domain_name=<object object>, emergency_calling_enabled=<object object>, secure=<object object>, byoc_trunk_sid=<object object>, emergency_caller_sid=<object object>)[source]¶ Update the DomainInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- voice_fallback_method (unicode) – The HTTP method used with voice_fallback_url
- voice_fallback_url (unicode) – The URL we should call when an error occurs in executing TwiML
- voice_method (unicode) – The HTTP method we should use with voice_url
- voice_status_callback_method (unicode) – The HTTP method we should use to call voice_status_callback_url
- voice_status_callback_url (unicode) – The URL that we should call to pass status updates
- voice_url (unicode) – The URL we should call when receiving a call
- sip_registration (bool) – Whether SIP registration is allowed
- domain_name (unicode) – The unique address on Twilio to route SIP traffic
- emergency_calling_enabled (bool) – Whether emergency calling is enabled for the domain.
- secure (bool) – Whether secure SIP is enabled for the domain
- byoc_trunk_sid (unicode) – The SID of the BYOC Trunk resource.
- emergency_caller_sid (unicode) – Whether an emergency caller sid is configured for the domain.
Returns: The updated DomainInstance
Return type:
-
uri
¶ Returns: The URI of the resource, relative to https://api.twilio.com 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 while executing TwiML Return type: unicode
-
voice_method
¶ Returns: The HTTP method to use with voice_url Return type: unicode
-
voice_status_callback_method
¶ Returns: The HTTP method we use to call voice_status_callback_url Return type: unicode
-
voice_status_callback_url
¶ Returns: The URL that we call with status updates Return type: unicode
-
voice_url
¶ Returns: The URL we call when receiving a call Return type: unicode
-
-
class
twilio.rest.api.v2010.account.sip.domain.
DomainList
(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(domain_name, friendly_name=<object object>, voice_url=<object object>, voice_method=<object object>, voice_fallback_url=<object object>, voice_fallback_method=<object object>, voice_status_callback_url=<object object>, voice_status_callback_method=<object object>, sip_registration=<object object>, emergency_calling_enabled=<object object>, secure=<object object>, byoc_trunk_sid=<object object>, emergency_caller_sid=<object object>)[source]¶ Create the DomainInstance
Parameters: - domain_name (unicode) – The unique address on Twilio to route SIP traffic
- friendly_name (unicode) – A string to describe the resource
- voice_url (unicode) – The URL we should call when receiving a call
- voice_method (unicode) – The HTTP method to use with voice_url
- voice_fallback_url (unicode) – The URL we should call when an error occurs in executing TwiML
- voice_fallback_method (unicode) – The HTTP method to use with voice_fallback_url
- voice_status_callback_url (unicode) – The URL that we should call to pass status updates
- voice_status_callback_method (unicode) – The HTTP method we should use to call voice_status_callback_url
- sip_registration (bool) – Whether SIP registration is allowed
- emergency_calling_enabled (bool) – Whether emergency calling is enabled for the domain.
- secure (bool) – Whether secure SIP is enabled for the domain
- byoc_trunk_sid (unicode) – The SID of the BYOC Trunk resource.
- emergency_caller_sid (unicode) – Whether an emergency caller sid is configured for the domain.
Returns: The created DomainInstance
Return type:
-
get
(sid)[source]¶ Constructs a DomainContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.api.v2010.account.sip.domain.DomainContext Return type: twilio.rest.api.v2010.account.sip.domain.DomainContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of DomainInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of DomainInstance Return type: twilio.rest.api.v2010.account.sip.domain.DomainPage
-
list
(limit=None, page_size=None)[source]¶ Lists DomainInstance 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.sip.domain.DomainInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of DomainInstance records from the API. Request is executed immediately
Parameters: Returns: Page of DomainInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams DomainInstance 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.sip.domain.DomainInstance]
-
-
class
twilio.rest.api.v2010.account.sip.domain.
DomainPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of DomainInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.sip.domain.DomainInstance Return type: twilio.rest.api.v2010.account.sip.domain.DomainInstance
-