You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: twilio/rest/api/v2010/account/call/__init__.py
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
58
58
"""
59
59
Create a new CallInstance
60
60
61
-
:param unicode to: Phone number, SIP address or client identifier to call
61
+
:param unicode to: Phone number, SIP address, or client identifier to call
62
62
:param unicode from_: Twilio number from which to originate the call
63
63
:param unicode method: HTTP method to use to fetch TwiML
64
64
:param unicode fallback_url: Fallback URL in case of error
@@ -72,14 +72,14 @@ def create(self, to, from_, method=values.unset, fallback_url=values.unset,
72
72
:param bool record: Whether or not to record the Call
73
73
:param unicode recording_channels: mono or dualSet this parameter to specify the number of channels in the final recording.
74
74
:param unicode recording_status_callback: A URL that Twilio will send a webhook request to when the recording is available for access.
75
-
:param unicode recording_status_callback_method: The HTTP method Twilio should use when requesting the above URL.
75
+
:param unicode recording_status_callback_method: The HTTP method Twilio should use when requesting the `RecordingStatusCallback` URL.
76
76
:param unicode sip_auth_username: The sip_auth_username
77
77
:param unicode sip_auth_password: The sip_auth_password
78
78
:param unicode machine_detection: Enable machine detection or end of greeting detection
79
79
:param unicode machine_detection_timeout: Number of miliseconds to wait for machine detection
80
80
:param unicode
10000
recording_status_callback_event: The recording status changes that Twilio will send webhooks on to the URL specified in RecordingStatusCallback.
81
81
:param unicode trim: Set this parameter to control trimming of silence on the recording.
82
-
:param unicode caller_id: The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`.
82
+
:param unicode caller_id: The phone number, SIP address, or Client identifier that made this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.
83
83
:param unicode url: Url from which to fetch TwiML
84
84
:param unicode application_sid: ApplicationSid that configures from where to fetch TwiML
85
85
@@ -629,23 +629,23 @@ def annotation(self):
629
629
@property
630
630
defanswered_by(self):
631
631
"""
632
-
:returns: If this call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise.
632
+
:returns: Either `human` or `machine` if this Call was initiated with answering machine detection. Empty otherwise.
633
633
:rtype: unicode
634
634
"""
635
635
returnself._properties['answered_by']
636
636
637
637
@property
638
638
defapi_version(self):
639
639
"""
640
-
:returns: The API Version the Call was created through
640
+
:returns: The API Version used to create the Call
641
641
:rtype: unicode
642
642
"""
643
643
returnself._properties['api_version']
644
644
645
645
@property
646
646
defcaller_name(self):
647
647
"""
648
-
:returns: If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name. Empty otherwise.
648
+
:returns: The caller's name if this Call was an incoming call to a phone number with Caller ID Lookup enabled. Empty otherwise.
649
649
:rtype: unicode
650
650
"""
651
651
returnself._properties['caller_name']
@@ -669,15 +669,15 @@ def date_updated(self):
669
669
@property
670
670
defdirection(self):
671
671
"""
672
-
:returns: A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.
672
+
:returns: A string describing the direction of the Call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.
673
673
:rtype: unicode
674
674
"""
675
675
returnself._properties['direction']
676
676
677
677
@property
678
678
defduration(self):
679
679
"""
680
-
:returns: The length of the call in seconds.
680
+
:returns: The length of the Call in seconds.
681
681
:rtype: unicode
682
682
"""
683
683
returnself._properties['duration']
@@ -693,15 +693,15 @@ def end_time(self):
693
693
@property
694
694
defforwarded_from(self):
695
695
"""
696
-
:returns: If this Call was an incoming call forwarded from another number, the forwarding phone number (depends on carrier supporting forwarding). Empty otherwise.
696
+
:returns: The forwarding phone number if this Call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Empty otherwise.
697
697
:rtype: unicode
698
698
"""
699
699
returnself._properties['forwarded_from']
700
700
701
701
@property
702
702
deffrom_(self):
703
703
"""
704
-
:returns: The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
704
+
:returns: The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
705
705
:rtype: unicode
706
706
"""
707
707
returnself._properties['from_']
@@ -717,31 +717,31 @@ def from_formatted(self):
717
717
@property
718
718
defgroup_sid(self):
719
719
"""
720
-
:returns: A 34character Group Sid associated with this Call. Empty if no Group is associated with the Call.
720
+
:returns: A 34-character Group Sid associated with this Call. Empty if no Group is associated with the Call.
721
721
:rtype: unicode
722
722
"""
723
723
returnself._properties['group_sid']
724
724
725
725
@property
726
726
defparent_call_sid(self):
727
727
"""
728
-
:returns: A 34character string that uniquely identifies the Call that created this leg.
728
+
:returns: A 34-character string that uniquely identifies the Call that created this leg.
729
729
:rtype: unicode
730
730
"""
731
731
returnself._properties['parent_call_sid']
732
732
733
733
@property
734
734
defphone_number_sid(self):
735
735
"""
736
-
:returns: If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call. If the call was outbound, it is the Sid of the OutgoingCallerId from which the call was placed.
736
+
:returns: If the call was inbound, this is the Sid of the `IncomingPhoneNumber` that received the call. If the call was outbound, it is the Sid of the `OutgoingCallerId` from which the call was placed.
737
737
:rtype: unicode
738
738
"""
739
739
returnself._properties['phone_number_sid']
740
740
741
741
@property
742
742
defprice(self):
743
743
"""
744
-
:returns: The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.
744
+
:returns: The charge for this Call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.
745
745
:rtype: unicode
746
746
"""
747
747
returnself._properties['price']
@@ -757,7 +757,7 @@ def price_unit(self):
757
757
@property
758
758
defsid(self):
759
759
"""
760
-
:returns: A 34character string that uniquely identifies this resource.
760
+
:returns: A 34-character string that uniquely identifies the Call resource.
761
761
:rtype: unicode
762
762
"""
763
763
returnself._properties['sid']
@@ -773,7 +773,7 @@ def start_time(self):
773
773
@property
774
774
defstatus(self):
775
775
"""
776
-
:returns: A string representing the status of the call.
776
+
:returns: A string representing the status of the Call.
777
777
:rtype: CallInstance.Status
778
778
"""
779
779
returnself._properties['status']
@@ -789,7 +789,7 @@ def subresource_uris(self):
789
789
@property
790
790
defto(self):
791
791
"""
792
-
:returns: The phone number, SIP address or Client identifier that received this Call. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
792
+
:returns: The phone number, SIP address or Client identifier that received this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. (π PII MTL: 120 days)
45
+
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details.
46
46
:param unicode role_sid: The role to be assigned to this member. Defaults to the roles specified on the Service.
47
47
:param unicode last_consumed_message_index: Field used to specify the last consumed Message index for the Channel for this Member. Should only be used when recreating a Member from a backup/separate source.
48
48
:param datetime last_consumption_timestamp: ISO8601 time indicating the last datetime the Member consumed a Message in the Channel. Should only be used when recreating a Member from a backup/separate source
The results are returned as a generator, so this operation is memory efficient.
83
83
84
-
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more det
B144
ails. (π PII MTL: 120 days)
84
+
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details.
85
85
:param int limit: Upper limit for the number of records to return. stream()
86
86
guarantees to never return more than limit. Default is no limit
87
87
:param int page_size: Number of records to fetch per request, when not set will use
Unlike stream(), this operation is eager and will load `limit` records into
105
105
memory before returning.
106
106
107
-
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. (π PII MTL: 120 days)
107
+
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details.
108
108
:param int limit: Upper limit for the number of records to return. list() guarantees
109
109
never to return more than limit. Default is no limit
110
110
:param int page_size: Number of records to fetch per request, when not set will use
Retrieve a single page of MemberInstance records from the API.
124
124
Request is executed immediately
125
125
126
-
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details. (π PII MTL: 120 days)
126
+
:param unicode identity: A unique string identifier for this User in this Service. See the access tokens docs for more details.
127
127
:param str page_token: PageToken provided by the API
128
128
:param int page_number: Page Number, this value is simply for client state
129
129
:param int page_size: Number of records to return, defaults to 50
0 commit comments