telnyx 3.4.0a0__py3-none-any.whl → 3.5.0a0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of telnyx might be problematic. Click here for more details.
- telnyx/__init__.py +3 -1
- telnyx/_base_client.py +9 -9
- telnyx/_client.py +35 -34
- telnyx/_models.py +10 -4
- telnyx/_qs.py +7 -7
- telnyx/_types.py +18 -11
- telnyx/_utils/_transform.py +2 -2
- telnyx/_utils/_utils.py +4 -4
- telnyx/_version.py +1 -1
- telnyx/resources/access_ip_address.py +15 -15
- telnyx/resources/access_ip_ranges.py +13 -13
- telnyx/resources/actions/purchase.py +13 -13
- telnyx/resources/actions/register.py +9 -9
- telnyx/resources/addresses/actions.py +13 -13
- telnyx/resources/addresses/addresses.py +33 -35
- telnyx/resources/advanced_orders.py +41 -45
- telnyx/resources/ai/ai.py +7 -7
- telnyx/resources/ai/assistants/assistants.py +89 -89
- telnyx/resources/ai/assistants/canary_deploys.py +9 -9
- telnyx/resources/ai/assistants/scheduled_events.py +21 -21
- telnyx/resources/ai/assistants/tests/runs.py +13 -13
- telnyx/resources/ai/assistants/tests/test_suites/runs.py +13 -13
- telnyx/resources/ai/assistants/tests/test_suites/test_suites.py +3 -3
- telnyx/resources/ai/assistants/tests/tests.py +43 -43
- telnyx/resources/ai/assistants/tools.py +7 -7
- telnyx/resources/ai/assistants/versions.py +45 -45
- telnyx/resources/ai/audio.py +11 -11
- telnyx/resources/ai/chat.py +47 -47
- telnyx/resources/ai/clusters.py +27 -27
- telnyx/resources/ai/conversations/conversations.py +43 -43
- telnyx/resources/ai/conversations/insight_groups/insight_groups.py +23 -23
- telnyx/resources/ai/conversations/insight_groups/insights.py +5 -5
- telnyx/resources/ai/conversations/insights.py +25 -25
- telnyx/resources/ai/conversations/messages.py +19 -19
- telnyx/resources/ai/embeddings/buckets.py +7 -7
- telnyx/resources/ai/embeddings/embeddings.py +23 -23
- telnyx/resources/ai/fine_tuning/jobs.py +13 -13
- telnyx/resources/audit_events.py +9 -9
- telnyx/resources/authentication_providers.py +29 -29
- telnyx/resources/available_phone_number_blocks.py +5 -5
- telnyx/resources/available_phone_numbers.py +5 -5
- telnyx/resources/balance.py +3 -3
- telnyx/resources/billing_groups.py +17 -17
- telnyx/resources/brand/brand.py +113 -113
- telnyx/resources/brand/external_vetting.py +9 -9
- telnyx/resources/bulk_sim_card_actions.py +11 -11
- telnyx/resources/bundle_pricing/billing_bundles.py +13 -13
- telnyx/resources/bundle_pricing/user_bundles.py +35 -35
- telnyx/resources/call_control_applications.py +63 -67
- telnyx/resources/call_events.py +7 -7
- telnyx/resources/calls/actions.py +549 -551
- telnyx/resources/calls/calls.py +99 -99
- telnyx/resources/campaign/campaign.py +47 -47
- telnyx/resources/campaign/osr.py +3 -3
- telnyx/resources/campaign/usecase.py +3 -3
- telnyx/resources/campaign_builder/brand.py +3 -3
- telnyx/resources/campaign_builder/campaign_builder.py +67 -67
- telnyx/resources/channel_zones.py +7 -7
- telnyx/resources/charges_breakdown.py +7 -7
- telnyx/resources/charges_summary.py +3 -3
- telnyx/resources/comments.py +17 -17
- telnyx/resources/conferences/actions.py +113 -113
- telnyx/resources/conferences/conferences.py +35 -35
- telnyx/resources/connections.py +15 -15
- telnyx/resources/country_coverage.py +5 -5
- telnyx/resources/credential_connections/actions.py +3 -3
- telnyx/resources/credential_connections/credential_connections.py +95 -95
- telnyx/resources/custom_storage_credentials.py +9 -9
- telnyx/resources/customer_service_records.py +19 -19
- telnyx/resources/detail_records.py +9 -9
- telnyx/resources/dialogflow_connections.py +25 -25
- telnyx/resources/document_links.py +7 -7
- telnyx/resources/documents.py +45 -45
- telnyx/resources/dynamic_emergency_addresses.py +23 -23
- telnyx/resources/dynamic_emergency_endpoints.py +13 -13
- telnyx/resources/enum.py +3 -3
- telnyx/resources/external_connections/civic_addresses.py +7 -7
- telnyx/resources/external_connections/external_connections.py +41 -41
- telnyx/resources/external_connections/log_messages.py +11 -11
- telnyx/resources/external_connections/phone_numbers.py +13 -13
- telnyx/resources/external_connections/releases.py +9 -9
- telnyx/resources/external_connections/uploads.py +25 -27
- telnyx/resources/fax_applications.py +47 -47
- telnyx/resources/faxes/actions.py +5 -5
- telnyx/resources/faxes/faxes.py +35 -35
- telnyx/resources/fqdn_connections.py +93 -93
- telnyx/resources/fqdns.py +25 -25
- telnyx/resources/global_ip_allowed_ports.py +3 -3
- telnyx/resources/global_ip_assignment_health.py +5 -5
- telnyx/resources/global_ip_assignments.py +19 -19
- telnyx/resources/global_ip_assignments_usage.py +5 -5
- telnyx/resources/global_ip_health_check_types.py +3 -3
- telnyx/resources/global_ip_health_checks.py +17 -17
- telnyx/resources/global_ip_latency.py +5 -5
- telnyx/resources/global_ip_protocols.py +3 -3
- telnyx/resources/global_ip_usage.py +5 -5
- telnyx/resources/global_ips.py +17 -17
- telnyx/resources/inbound_channels.py +5 -5
- telnyx/resources/integration_secrets.py +17 -17
- telnyx/resources/inventory_coverage.py +5 -5
- telnyx/resources/invoices.py +11 -11
- telnyx/resources/ip_connections.py +93 -93
- telnyx/resources/ips.py +23 -23
- telnyx/resources/ledger_billing_group_reports.py +9 -9
- telnyx/resources/list.py +5 -5
- telnyx/resources/managed_accounts/actions.py +7 -7
- telnyx/resources/managed_accounts/managed_accounts.py +33 -33
- telnyx/resources/media.py +23 -23
- telnyx/resources/messages/messages.py +121 -121
- telnyx/resources/messages/rcs.py +7 -7
- telnyx/resources/messaging/rcs/agents.py +15 -15
- telnyx/resources/messaging/rcs/rcs.py +7 -7
- telnyx/resources/messaging_hosted_number_orders/actions.py +7 -7
- telnyx/resources/messaging_hosted_number_orders/messaging_hosted_number_orders.py +21 -21
- telnyx/resources/messaging_hosted_numbers.py +3 -3
- telnyx/resources/messaging_numbers_bulk_updates.py +5 -5
- telnyx/resources/messaging_optouts.py +11 -11
- telnyx/resources/messaging_profiles/autoresp_configs.py +21 -21
- telnyx/resources/messaging_profiles/messaging_profiles.py +73 -73
- telnyx/resources/messaging_tollfree/verification/requests.py +27 -27
- telnyx/resources/messaging_url_domains.py +5 -5
- telnyx/resources/messsages.py +11 -11
- telnyx/resources/mobile_network_operators.py +7 -7
- telnyx/resources/mobile_push_credentials.py +23 -23
- telnyx/resources/network_coverage.py +9 -9
- telnyx/resources/networks/default_gateway.py +9 -9
- telnyx/resources/networks/networks.py +21 -21
- telnyx/resources/notification_channels.py +27 -27
- telnyx/resources/notification_event_conditions.py +7 -7
- telnyx/resources/notification_events.py +5 -5
- telnyx/resources/notification_profiles.py +17 -17
- telnyx/resources/notification_settings.py +21 -21
- telnyx/resources/number_block_orders.py +17 -17
- telnyx/resources/number_lookup.py +5 -5
- telnyx/resources/number_order_phone_numbers.py +13 -13
- telnyx/resources/number_orders.py +27 -27
- telnyx/resources/number_reservations/actions.py +3 -3
- telnyx/resources/number_reservations/number_reservations.py +15 -15
- telnyx/resources/numbers_features.py +3 -3
- telnyx/resources/operator_connect/actions.py +3 -3
- telnyx/resources/ota_updates.py +9 -9
- telnyx/resources/outbound_voice_profiles.py +65 -65
- telnyx/resources/partner_campaigns.py +25 -25
- telnyx/resources/payment/auto_recharge_prefs.py +15 -15
- telnyx/resources/phone_number_assignment_by_profile.py +15 -15
- telnyx/resources/phone_number_blocks/jobs.py +13 -13
- telnyx/resources/phone_number_campaigns.py +19 -19
- telnyx/resources/phone_numbers/actions.py +7 -7
- telnyx/resources/phone_numbers/csv_downloads.py +13 -13
- telnyx/resources/phone_numbers/jobs.py +35 -35
- telnyx/resources/phone_numbers/messaging.py +13 -13
- telnyx/resources/phone_numbers/phone_numbers.py +39 -39
- telnyx/resources/phone_numbers/voice.py +31 -31
- telnyx/resources/phone_numbers/voicemail.py +15 -15
- telnyx/resources/phone_numbers_regulatory_requirements.py +5 -5
- telnyx/resources/portability_checks.py +5 -5
- telnyx/resources/porting/events.py +11 -11
- telnyx/resources/porting/loa_configurations.py +17 -17
- telnyx/resources/porting/porting.py +3 -3
- telnyx/resources/porting/reports.py +11 -11
- telnyx/resources/porting_orders/action_requirements.py +11 -11
- telnyx/resources/porting_orders/actions.py +13 -13
- telnyx/resources/porting_orders/activation_jobs.py +11 -11
- telnyx/resources/porting_orders/additional_documents.py +15 -15
- telnyx/resources/porting_orders/associated_phone_numbers.py +13 -13
- telnyx/resources/porting_orders/comments.py +9 -9
- telnyx/resources/porting_orders/phone_number_blocks.py +13 -13
- telnyx/resources/porting_orders/phone_number_configurations.py +13 -13
- telnyx/resources/porting_orders/phone_number_extensions.py +13 -13
- telnyx/resources/porting_orders/porting_orders.py +59 -59
- telnyx/resources/porting_orders/verification_codes.py +19 -19
- telnyx/resources/porting_phone_numbers.py +7 -7
- telnyx/resources/portouts/comments.py +7 -7
- telnyx/resources/portouts/events.py +11 -11
- telnyx/resources/portouts/portouts.py +17 -17
- telnyx/resources/portouts/reports.py +11 -11
- telnyx/resources/portouts/supporting_documents.py +7 -7
- telnyx/resources/private_wireless_gateways.py +25 -25
- telnyx/resources/public_internet_gateways.py +19 -19
- telnyx/resources/queues/calls.py +7 -7
- telnyx/resources/queues/queues.py +3 -3
- telnyx/resources/recording_transcriptions.py +7 -7
- telnyx/resources/recordings/actions.py +3 -3
- telnyx/resources/recordings/recordings.py +11 -11
- telnyx/resources/regions.py +3 -3
- telnyx/resources/regulatory_requirements.py +5 -5
- telnyx/resources/reports/cdr_usage_reports.py +9 -9
- telnyx/resources/reports/mdr_usage_reports.py +21 -21
- telnyx/resources/reports/reports.py +47 -47
- telnyx/resources/requirement_groups.py +23 -23
- telnyx/resources/requirement_types.py +9 -11
- telnyx/resources/requirements.py +11 -11
- telnyx/resources/room_compositions.py +27 -27
- telnyx/resources/room_participants.py +9 -9
- telnyx/resources/room_recordings.py +17 -17
- telnyx/resources/rooms/actions.py +11 -11
- telnyx/resources/rooms/rooms.py +43 -43
- telnyx/resources/rooms/sessions/actions.py +21 -21
- telnyx/resources/rooms/sessions/sessions.py +27 -27
- telnyx/resources/seti.py +5 -5
- telnyx/resources/short_codes.py +11 -11
- telnyx/resources/sim_card_data_usage_notifications.py +21 -21
- telnyx/resources/sim_card_groups/actions.py +23 -23
- telnyx/resources/sim_card_groups/sim_card_groups.py +29 -29
- telnyx/resources/sim_card_order_preview.py +3 -3
- telnyx/resources/sim_card_orders.py +11 -11
- telnyx/resources/sim_cards/actions.py +27 -27
- telnyx/resources/sim_cards/sim_cards.py +47 -47
- telnyx/resources/siprec_connectors.py +13 -13
- telnyx/resources/storage/buckets/buckets.py +5 -5
- telnyx/resources/storage/buckets/ssl_certificate.py +11 -11
- telnyx/resources/storage/buckets/usage.py +5 -5
- telnyx/resources/storage/migration_sources.py +11 -11
- telnyx/resources/storage/migrations/actions.py +3 -3
- telnyx/resources/storage/migrations/migrations.py +9 -9
- telnyx/resources/storage/storage.py +3 -3
- telnyx/resources/sub_number_orders.py +17 -17
- telnyx/resources/sub_number_orders_report.py +19 -19
- telnyx/resources/telephony_credentials.py +31 -31
- telnyx/resources/texml/accounts/accounts.py +15 -15
- telnyx/resources/texml/accounts/calls/calls.py +145 -145
- telnyx/resources/texml/accounts/calls/recordings.py +5 -5
- telnyx/resources/texml/accounts/calls/recordings_json.py +19 -19
- telnyx/resources/texml/accounts/calls/siprec.py +5 -5
- telnyx/resources/texml/accounts/calls/streams.py +5 -5
- telnyx/resources/texml/accounts/conferences/conferences.py +31 -31
- telnyx/resources/texml/accounts/conferences/participants.py +123 -123
- telnyx/resources/texml/accounts/recordings/json.py +5 -5
- telnyx/resources/texml/accounts/transcriptions/json.py +5 -5
- telnyx/resources/texml/calls.py +79 -79
- telnyx/resources/texml/texml.py +3 -3
- telnyx/resources/texml_applications.py +65 -65
- telnyx/resources/text_to_speech.py +9 -9
- telnyx/resources/usage_reports.py +27 -27
- telnyx/resources/user_addresses.py +29 -31
- telnyx/resources/user_tags.py +5 -5
- telnyx/resources/verifications/actions.py +7 -7
- telnyx/resources/verifications/by_phone_number/actions.py +3 -3
- telnyx/resources/verifications/by_phone_number/by_phone_number.py +3 -3
- telnyx/resources/verifications/verifications.py +19 -19
- telnyx/resources/verified_numbers/actions.py +3 -3
- telnyx/resources/verified_numbers/verified_numbers.py +11 -11
- telnyx/resources/verify_profiles.py +43 -43
- telnyx/resources/virtual_cross_connects.py +45 -45
- telnyx/resources/virtual_cross_connects_coverage.py +9 -9
- telnyx/resources/webhook_deliveries.py +9 -9
- telnyx/resources/wireguard_interfaces.py +17 -17
- telnyx/resources/wireguard_peers.py +21 -21
- telnyx/resources/wireless/detail_records_reports.py +17 -17
- telnyx/resources/wireless/wireless.py +3 -3
- telnyx/resources/wireless_blocklist_values.py +3 -3
- telnyx/resources/wireless_blocklists.py +27 -27
- telnyx/types/global_ip_latency_retrieve_response.py +7 -7
- {telnyx-3.4.0a0.dist-info → telnyx-3.5.0a0.dist-info}/METADATA +58 -17
- {telnyx-3.4.0a0.dist-info → telnyx-3.5.0a0.dist-info}/RECORD +257 -257
- {telnyx-3.4.0a0.dist-info → telnyx-3.5.0a0.dist-info}/WHEEL +0 -0
- {telnyx-3.4.0a0.dist-info → telnyx-3.5.0a0.dist-info}/licenses/LICENSE +0 -0
|
@@ -13,7 +13,7 @@ from ...types import (
|
|
|
13
13
|
StreamBidirectionalCodec,
|
|
14
14
|
StreamBidirectionalTargetLegs,
|
|
15
15
|
)
|
|
16
|
-
from ..._types import
|
|
16
|
+
from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
17
17
|
from ..._utils import maybe_transform, async_maybe_transform
|
|
18
18
|
from ..._compat import cached_property
|
|
19
19
|
from ..._resource import SyncAPIResource, AsyncAPIResource
|
|
@@ -141,38 +141,38 @@ class ActionsResource(SyncAPIResource):
|
|
|
141
141
|
self,
|
|
142
142
|
call_control_id: str,
|
|
143
143
|
*,
|
|
144
|
-
billing_group_id: str |
|
|
145
|
-
client_state: str |
|
|
146
|
-
command_id: str |
|
|
147
|
-
custom_headers: Iterable[CustomSipHeaderParam] |
|
|
148
|
-
preferred_codecs: Literal["G722,PCMU,PCMA,G729,OPUS,VP8,H264"] |
|
|
149
|
-
record: Literal["record-from-answer"] |
|
|
150
|
-
record_channels: Literal["single", "dual"] |
|
|
151
|
-
record_custom_file_name: str |
|
|
152
|
-
record_format: Literal["wav", "mp3"] |
|
|
153
|
-
record_max_length: int |
|
|
154
|
-
record_timeout_secs: int |
|
|
155
|
-
record_track: Literal["both", "inbound", "outbound"] |
|
|
156
|
-
record_trim: Literal["trim-silence"] |
|
|
157
|
-
send_silence_when_idle: bool |
|
|
158
|
-
sip_headers: Iterable[SipHeaderParam] |
|
|
159
|
-
sound_modifications: SoundModificationsParam |
|
|
160
|
-
stream_bidirectional_codec: StreamBidirectionalCodec |
|
|
161
|
-
stream_bidirectional_mode: StreamBidirectionalMode |
|
|
162
|
-
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs |
|
|
163
|
-
stream_codec: StreamCodec |
|
|
164
|
-
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
165
|
-
stream_url: str |
|
|
166
|
-
transcription: bool |
|
|
167
|
-
transcription_config: TranscriptionStartRequestParam |
|
|
168
|
-
webhook_url: str |
|
|
169
|
-
webhook_url_method: Literal["POST", "GET"] |
|
|
144
|
+
billing_group_id: str | Omit = omit,
|
|
145
|
+
client_state: str | Omit = omit,
|
|
146
|
+
command_id: str | Omit = omit,
|
|
147
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
148
|
+
preferred_codecs: Literal["G722,PCMU,PCMA,G729,OPUS,VP8,H264"] | Omit = omit,
|
|
149
|
+
record: Literal["record-from-answer"] | Omit = omit,
|
|
150
|
+
record_channels: Literal["single", "dual"] | Omit = omit,
|
|
151
|
+
record_custom_file_name: str | Omit = omit,
|
|
152
|
+
record_format: Literal["wav", "mp3"] | Omit = omit,
|
|
153
|
+
record_max_length: int | Omit = omit,
|
|
154
|
+
record_timeout_secs: int | Omit = omit,
|
|
155
|
+
record_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
156
|
+
record_trim: Literal["trim-silence"] | Omit = omit,
|
|
157
|
+
send_silence_when_idle: bool | Omit = omit,
|
|
158
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
159
|
+
sound_modifications: SoundModificationsParam | Omit = omit,
|
|
160
|
+
stream_bidirectional_codec: StreamBidirectionalCodec | Omit = omit,
|
|
161
|
+
stream_bidirectional_mode: StreamBidirectionalMode | Omit = omit,
|
|
162
|
+
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs | Omit = omit,
|
|
163
|
+
stream_codec: StreamCodec | Omit = omit,
|
|
164
|
+
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
165
|
+
stream_url: str | Omit = omit,
|
|
166
|
+
transcription: bool | Omit = omit,
|
|
167
|
+
transcription_config: TranscriptionStartRequestParam | Omit = omit,
|
|
168
|
+
webhook_url: str | Omit = omit,
|
|
169
|
+
webhook_url_method: Literal["POST", "GET"] | Omit = omit,
|
|
170
170
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
171
171
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
172
172
|
extra_headers: Headers | None = None,
|
|
173
173
|
extra_query: Query | None = None,
|
|
174
174
|
extra_body: Body | None = None,
|
|
175
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
175
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
176
176
|
) -> ActionAnswerResponse:
|
|
177
177
|
"""Answer an incoming call.
|
|
178
178
|
|
|
@@ -315,20 +315,20 @@ class ActionsResource(SyncAPIResource):
|
|
|
315
315
|
path_call_control_id: str,
|
|
316
316
|
*,
|
|
317
317
|
body_call_control_id: str,
|
|
318
|
-
client_state: str |
|
|
319
|
-
command_id: str |
|
|
320
|
-
mute_dtmf: Literal["none", "both", "self", "opposite"] |
|
|
321
|
-
park_after_unbridge: str |
|
|
322
|
-
play_ringtone: bool |
|
|
323
|
-
queue: str |
|
|
324
|
-
record: Literal["record-from-answer"] |
|
|
325
|
-
record_channels: Literal["single", "dual"] |
|
|
326
|
-
record_custom_file_name: str |
|
|
327
|
-
record_format: Literal["wav", "mp3"] |
|
|
328
|
-
record_max_length: int |
|
|
329
|
-
record_timeout_secs: int |
|
|
330
|
-
record_track: Literal["both", "inbound", "outbound"] |
|
|
331
|
-
record_trim: Literal["trim-silence"] |
|
|
318
|
+
client_state: str | Omit = omit,
|
|
319
|
+
command_id: str | Omit = omit,
|
|
320
|
+
mute_dtmf: Literal["none", "both", "self", "opposite"] | Omit = omit,
|
|
321
|
+
park_after_unbridge: str | Omit = omit,
|
|
322
|
+
play_ringtone: bool | Omit = omit,
|
|
323
|
+
queue: str | Omit = omit,
|
|
324
|
+
record: Literal["record-from-answer"] | Omit = omit,
|
|
325
|
+
record_channels: Literal["single", "dual"] | Omit = omit,
|
|
326
|
+
record_custom_file_name: str | Omit = omit,
|
|
327
|
+
record_format: Literal["wav", "mp3"] | Omit = omit,
|
|
328
|
+
record_max_length: int | Omit = omit,
|
|
329
|
+
record_timeout_secs: int | Omit = omit,
|
|
330
|
+
record_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
331
|
+
record_trim: Literal["trim-silence"] | Omit = omit,
|
|
332
332
|
ringtone: Literal[
|
|
333
333
|
"at",
|
|
334
334
|
"au",
|
|
@@ -371,15 +371,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
371
371
|
"ve",
|
|
372
372
|
"za",
|
|
373
373
|
]
|
|
374
|
-
|
|
|
375
|
-
video_room_context: str |
|
|
376
|
-
video_room_id: str |
|
|
374
|
+
| Omit = omit,
|
|
375
|
+
video_room_context: str | Omit = omit,
|
|
376
|
+
video_room_id: str | Omit = omit,
|
|
377
377
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
378
378
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
379
379
|
extra_headers: Headers | None = None,
|
|
380
380
|
extra_query: Query | None = None,
|
|
381
381
|
extra_body: Body | None = None,
|
|
382
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
382
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
383
383
|
) -> ActionBridgeResponse:
|
|
384
384
|
"""
|
|
385
385
|
Bridge two call control calls.
|
|
@@ -503,16 +503,16 @@ class ActionsResource(SyncAPIResource):
|
|
|
503
503
|
call_control_id: str,
|
|
504
504
|
*,
|
|
505
505
|
queue_name: str,
|
|
506
|
-
client_state: str |
|
|
507
|
-
command_id: str |
|
|
508
|
-
max_size: int |
|
|
509
|
-
max_wait_time_secs: int |
|
|
506
|
+
client_state: str | Omit = omit,
|
|
507
|
+
command_id: str | Omit = omit,
|
|
508
|
+
max_size: int | Omit = omit,
|
|
509
|
+
max_wait_time_secs: int | Omit = omit,
|
|
510
510
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
511
511
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
512
512
|
extra_headers: Headers | None = None,
|
|
513
513
|
extra_query: Query | None = None,
|
|
514
514
|
extra_body: Body | None = None,
|
|
515
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
515
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
516
516
|
) -> ActionEnqueueResponse:
|
|
517
517
|
"""
|
|
518
518
|
Put the call in a queue.
|
|
@@ -564,22 +564,22 @@ class ActionsResource(SyncAPIResource):
|
|
|
564
564
|
self,
|
|
565
565
|
call_control_id: str,
|
|
566
566
|
*,
|
|
567
|
-
client_state: str |
|
|
568
|
-
command_id: str |
|
|
569
|
-
gather_id: str |
|
|
570
|
-
initial_timeout_millis: int |
|
|
571
|
-
inter_digit_timeout_millis: int |
|
|
572
|
-
maximum_digits: int |
|
|
573
|
-
minimum_digits: int |
|
|
574
|
-
terminating_digit: str |
|
|
575
|
-
timeout_millis: int |
|
|
576
|
-
valid_digits: str |
|
|
567
|
+
client_state: str | Omit = omit,
|
|
568
|
+
command_id: str | Omit = omit,
|
|
569
|
+
gather_id: str | Omit = omit,
|
|
570
|
+
initial_timeout_millis: int | Omit = omit,
|
|
571
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
572
|
+
maximum_digits: int | Omit = omit,
|
|
573
|
+
minimum_digits: int | Omit = omit,
|
|
574
|
+
terminating_digit: str | Omit = omit,
|
|
575
|
+
timeout_millis: int | Omit = omit,
|
|
576
|
+
valid_digits: str | Omit = omit,
|
|
577
577
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
578
578
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
579
579
|
extra_headers: Headers | None = None,
|
|
580
580
|
extra_query: Query | None = None,
|
|
581
581
|
extra_body: Body | None = None,
|
|
582
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
582
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
583
583
|
) -> ActionGatherResponse:
|
|
584
584
|
"""
|
|
585
585
|
Gather DTMF signals to build interactive menus.
|
|
@@ -658,25 +658,25 @@ class ActionsResource(SyncAPIResource):
|
|
|
658
658
|
call_control_id: str,
|
|
659
659
|
*,
|
|
660
660
|
parameters: object,
|
|
661
|
-
assistant: AssistantParam |
|
|
662
|
-
client_state: str |
|
|
663
|
-
command_id: str |
|
|
664
|
-
greeting: str |
|
|
665
|
-
interruption_settings: InterruptionSettingsParam |
|
|
666
|
-
language: GoogleTranscriptionLanguage |
|
|
667
|
-
message_history: Iterable[action_gather_using_ai_params.MessageHistory] |
|
|
668
|
-
send_message_history_updates: bool |
|
|
669
|
-
send_partial_results: bool |
|
|
670
|
-
transcription: TranscriptionConfigParam |
|
|
671
|
-
user_response_timeout_ms: int |
|
|
672
|
-
voice: str |
|
|
673
|
-
voice_settings: action_gather_using_ai_params.VoiceSettings |
|
|
661
|
+
assistant: AssistantParam | Omit = omit,
|
|
662
|
+
client_state: str | Omit = omit,
|
|
663
|
+
command_id: str | Omit = omit,
|
|
664
|
+
greeting: str | Omit = omit,
|
|
665
|
+
interruption_settings: InterruptionSettingsParam | Omit = omit,
|
|
666
|
+
language: GoogleTranscriptionLanguage | Omit = omit,
|
|
667
|
+
message_history: Iterable[action_gather_using_ai_params.MessageHistory] | Omit = omit,
|
|
668
|
+
send_message_history_updates: bool | Omit = omit,
|
|
669
|
+
send_partial_results: bool | Omit = omit,
|
|
670
|
+
transcription: TranscriptionConfigParam | Omit = omit,
|
|
671
|
+
user_response_timeout_ms: int | Omit = omit,
|
|
672
|
+
voice: str | Omit = omit,
|
|
673
|
+
voice_settings: action_gather_using_ai_params.VoiceSettings | Omit = omit,
|
|
674
674
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
675
675
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
676
676
|
extra_headers: Headers | None = None,
|
|
677
677
|
extra_query: Query | None = None,
|
|
678
678
|
extra_body: Body | None = None,
|
|
679
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
679
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
680
680
|
) -> ActionGatherUsingAIResponse:
|
|
681
681
|
"""
|
|
682
682
|
Gather parameters defined in the request payload using a voice assistant.
|
|
@@ -806,25 +806,25 @@ class ActionsResource(SyncAPIResource):
|
|
|
806
806
|
self,
|
|
807
807
|
call_control_id: str,
|
|
808
808
|
*,
|
|
809
|
-
audio_url: str |
|
|
810
|
-
client_state: str |
|
|
811
|
-
command_id: str |
|
|
812
|
-
inter_digit_timeout_millis: int |
|
|
813
|
-
invalid_audio_url: str |
|
|
814
|
-
invalid_media_name: str |
|
|
815
|
-
maximum_digits: int |
|
|
816
|
-
maximum_tries: int |
|
|
817
|
-
media_name: str |
|
|
818
|
-
minimum_digits: int |
|
|
819
|
-
terminating_digit: str |
|
|
820
|
-
timeout_millis: int |
|
|
821
|
-
valid_digits: str |
|
|
809
|
+
audio_url: str | Omit = omit,
|
|
810
|
+
client_state: str | Omit = omit,
|
|
811
|
+
command_id: str | Omit = omit,
|
|
812
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
813
|
+
invalid_audio_url: str | Omit = omit,
|
|
814
|
+
invalid_media_name: str | Omit = omit,
|
|
815
|
+
maximum_digits: int | Omit = omit,
|
|
816
|
+
maximum_tries: int | Omit = omit,
|
|
817
|
+
media_name: str | Omit = omit,
|
|
818
|
+
minimum_digits: int | Omit = omit,
|
|
819
|
+
terminating_digit: str | Omit = omit,
|
|
820
|
+
timeout_millis: int | Omit = omit,
|
|
821
|
+
valid_digits: str | Omit = omit,
|
|
822
822
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
823
823
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
824
824
|
extra_headers: Headers | None = None,
|
|
825
825
|
extra_query: Query | None = None,
|
|
826
826
|
extra_body: Body | None = None,
|
|
827
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
827
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
828
828
|
) -> ActionGatherUsingAudioResponse:
|
|
829
829
|
"""
|
|
830
830
|
Play an audio file on the call until the required DTMF signals are gathered to
|
|
@@ -930,10 +930,10 @@ class ActionsResource(SyncAPIResource):
|
|
|
930
930
|
*,
|
|
931
931
|
payload: str,
|
|
932
932
|
voice: str,
|
|
933
|
-
client_state: str |
|
|
934
|
-
command_id: str |
|
|
935
|
-
inter_digit_timeout_millis: int |
|
|
936
|
-
invalid_payload: str |
|
|
933
|
+
client_state: str | Omit = omit,
|
|
934
|
+
command_id: str | Omit = omit,
|
|
935
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
936
|
+
invalid_payload: str | Omit = omit,
|
|
937
937
|
language: Literal[
|
|
938
938
|
"arb",
|
|
939
939
|
"cmn-CN",
|
|
@@ -965,22 +965,22 @@ class ActionsResource(SyncAPIResource):
|
|
|
965
965
|
"sv-SE",
|
|
966
966
|
"tr-TR",
|
|
967
967
|
]
|
|
968
|
-
|
|
|
969
|
-
maximum_digits: int |
|
|
970
|
-
maximum_tries: int |
|
|
971
|
-
minimum_digits: int |
|
|
972
|
-
payload_type: Literal["text", "ssml"] |
|
|
973
|
-
service_level: Literal["basic", "premium"] |
|
|
974
|
-
terminating_digit: str |
|
|
975
|
-
timeout_millis: int |
|
|
976
|
-
valid_digits: str |
|
|
977
|
-
voice_settings: action_gather_using_speak_params.VoiceSettings |
|
|
968
|
+
| Omit = omit,
|
|
969
|
+
maximum_digits: int | Omit = omit,
|
|
970
|
+
maximum_tries: int | Omit = omit,
|
|
971
|
+
minimum_digits: int | Omit = omit,
|
|
972
|
+
payload_type: Literal["text", "ssml"] | Omit = omit,
|
|
973
|
+
service_level: Literal["basic", "premium"] | Omit = omit,
|
|
974
|
+
terminating_digit: str | Omit = omit,
|
|
975
|
+
timeout_millis: int | Omit = omit,
|
|
976
|
+
valid_digits: str | Omit = omit,
|
|
977
|
+
voice_settings: action_gather_using_speak_params.VoiceSettings | Omit = omit,
|
|
978
978
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
979
979
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
980
980
|
extra_headers: Headers | None = None,
|
|
981
981
|
extra_query: Query | None = None,
|
|
982
982
|
extra_body: Body | None = None,
|
|
983
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
983
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
984
984
|
) -> ActionGatherUsingSpeakResponse:
|
|
985
985
|
"""
|
|
986
986
|
Convert text to speech and play it on the call until the required DTMF signals
|
|
@@ -1112,14 +1112,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
1112
1112
|
self,
|
|
1113
1113
|
call_control_id: str,
|
|
1114
1114
|
*,
|
|
1115
|
-
client_state: str |
|
|
1116
|
-
command_id: str |
|
|
1115
|
+
client_state: str | Omit = omit,
|
|
1116
|
+
command_id: str | Omit = omit,
|
|
1117
1117
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1118
1118
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1119
1119
|
extra_headers: Headers | None = None,
|
|
1120
1120
|
extra_query: Query | None = None,
|
|
1121
1121
|
extra_body: Body | None = None,
|
|
1122
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1122
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1123
1123
|
) -> ActionHangupResponse:
|
|
1124
1124
|
"""
|
|
1125
1125
|
Hang up the call.
|
|
@@ -1167,14 +1167,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
1167
1167
|
self,
|
|
1168
1168
|
call_control_id: str,
|
|
1169
1169
|
*,
|
|
1170
|
-
client_state: str |
|
|
1171
|
-
command_id: str |
|
|
1170
|
+
client_state: str | Omit = omit,
|
|
1171
|
+
command_id: str | Omit = omit,
|
|
1172
1172
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1173
1173
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1174
1174
|
extra_headers: Headers | None = None,
|
|
1175
1175
|
extra_query: Query | None = None,
|
|
1176
1176
|
extra_body: Body | None = None,
|
|
1177
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1177
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1178
1178
|
) -> ActionLeaveQueueResponse:
|
|
1179
1179
|
"""
|
|
1180
1180
|
Removes the call from a queue.
|
|
@@ -1215,15 +1215,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
1215
1215
|
self,
|
|
1216
1216
|
call_control_id: str,
|
|
1217
1217
|
*,
|
|
1218
|
-
client_state: str |
|
|
1219
|
-
command_id: str |
|
|
1220
|
-
recording_id: str |
|
|
1218
|
+
client_state: str | Omit = omit,
|
|
1219
|
+
command_id: str | Omit = omit,
|
|
1220
|
+
recording_id: str | Omit = omit,
|
|
1221
1221
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1222
1222
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1223
1223
|
extra_headers: Headers | None = None,
|
|
1224
1224
|
extra_query: Query | None = None,
|
|
1225
1225
|
extra_body: Body | None = None,
|
|
1226
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1226
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1227
1227
|
) -> ActionPauseRecordingResponse:
|
|
1228
1228
|
"""Pause recording the call.
|
|
1229
1229
|
|
|
@@ -1273,18 +1273,18 @@ class ActionsResource(SyncAPIResource):
|
|
|
1273
1273
|
call_control_id: str,
|
|
1274
1274
|
*,
|
|
1275
1275
|
sip_address: str,
|
|
1276
|
-
client_state: str |
|
|
1277
|
-
command_id: str |
|
|
1278
|
-
custom_headers: Iterable[CustomSipHeaderParam] |
|
|
1279
|
-
sip_auth_password: str |
|
|
1280
|
-
sip_auth_username: str |
|
|
1281
|
-
sip_headers: Iterable[SipHeaderParam] |
|
|
1276
|
+
client_state: str | Omit = omit,
|
|
1277
|
+
command_id: str | Omit = omit,
|
|
1278
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
1279
|
+
sip_auth_password: str | Omit = omit,
|
|
1280
|
+
sip_auth_username: str | Omit = omit,
|
|
1281
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
1282
1282
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1283
1283
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1284
1284
|
extra_headers: Headers | None = None,
|
|
1285
1285
|
extra_query: Query | None = None,
|
|
1286
1286
|
extra_body: Body | None = None,
|
|
1287
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1287
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1288
1288
|
) -> ActionReferResponse:
|
|
1289
1289
|
"""Initiate a SIP Refer on a Call Control call.
|
|
1290
1290
|
|
|
@@ -1353,14 +1353,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
1353
1353
|
call_control_id: str,
|
|
1354
1354
|
*,
|
|
1355
1355
|
cause: Literal["CALL_REJECTED", "USER_BUSY"],
|
|
1356
|
-
client_state: str |
|
|
1357
|
-
command_id: str |
|
|
1356
|
+
client_state: str | Omit = omit,
|
|
1357
|
+
command_id: str | Omit = omit,
|
|
1358
1358
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1359
1359
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1360
1360
|
extra_headers: Headers | None = None,
|
|
1361
1361
|
extra_query: Query | None = None,
|
|
1362
1362
|
extra_body: Body | None = None,
|
|
1363
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1363
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1364
1364
|
) -> ActionRejectResponse:
|
|
1365
1365
|
"""
|
|
1366
1366
|
Reject an incoming call.
|
|
@@ -1410,15 +1410,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
1410
1410
|
self,
|
|
1411
1411
|
call_control_id: str,
|
|
1412
1412
|
*,
|
|
1413
|
-
client_state: str |
|
|
1414
|
-
command_id: str |
|
|
1415
|
-
recording_id: str |
|
|
1413
|
+
client_state: str | Omit = omit,
|
|
1414
|
+
command_id: str | Omit = omit,
|
|
1415
|
+
recording_id: str | Omit = omit,
|
|
1416
1416
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1417
1417
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1418
1418
|
extra_headers: Headers | None = None,
|
|
1419
1419
|
extra_query: Query | None = None,
|
|
1420
1420
|
extra_body: Body | None = None,
|
|
1421
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1421
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1422
1422
|
) -> ActionResumeRecordingResponse:
|
|
1423
1423
|
"""
|
|
1424
1424
|
Resume recording the call.
|
|
@@ -1467,15 +1467,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
1467
1467
|
call_control_id: str,
|
|
1468
1468
|
*,
|
|
1469
1469
|
digits: str,
|
|
1470
|
-
client_state: str |
|
|
1471
|
-
command_id: str |
|
|
1472
|
-
duration_millis: int |
|
|
1470
|
+
client_state: str | Omit = omit,
|
|
1471
|
+
command_id: str | Omit = omit,
|
|
1472
|
+
duration_millis: int | Omit = omit,
|
|
1473
1473
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1474
1474
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1475
1475
|
extra_headers: Headers | None = None,
|
|
1476
1476
|
extra_query: Query | None = None,
|
|
1477
1477
|
extra_body: Body | None = None,
|
|
1478
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1478
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1479
1479
|
) -> ActionSendDtmfResponse:
|
|
1480
1480
|
"""Sends DTMF tones from this leg.
|
|
1481
1481
|
|
|
@@ -1532,14 +1532,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
1532
1532
|
*,
|
|
1533
1533
|
body: str,
|
|
1534
1534
|
content_type: str,
|
|
1535
|
-
client_state: str |
|
|
1536
|
-
command_id: str |
|
|
1535
|
+
client_state: str | Omit = omit,
|
|
1536
|
+
command_id: str | Omit = omit,
|
|
1537
1537
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1538
1538
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1539
1539
|
extra_headers: Headers | None = None,
|
|
1540
1540
|
extra_query: Query | None = None,
|
|
1541
1541
|
extra_body: Body | None = None,
|
|
1542
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1542
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1543
1543
|
) -> ActionSendSipInfoResponse:
|
|
1544
1544
|
"""
|
|
1545
1545
|
Sends SIP info from this leg.
|
|
@@ -1593,8 +1593,8 @@ class ActionsResource(SyncAPIResource):
|
|
|
1593
1593
|
*,
|
|
1594
1594
|
payload: str,
|
|
1595
1595
|
voice: str,
|
|
1596
|
-
client_state: str |
|
|
1597
|
-
command_id: str |
|
|
1596
|
+
client_state: str | Omit = omit,
|
|
1597
|
+
command_id: str | Omit = omit,
|
|
1598
1598
|
language: Literal[
|
|
1599
1599
|
"arb",
|
|
1600
1600
|
"cmn-CN",
|
|
@@ -1626,17 +1626,17 @@ class ActionsResource(SyncAPIResource):
|
|
|
1626
1626
|
"sv-SE",
|
|
1627
1627
|
"tr-TR",
|
|
1628
1628
|
]
|
|
1629
|
-
|
|
|
1630
|
-
payload_type: Literal["text", "ssml"] |
|
|
1631
|
-
service_level: Literal["basic", "premium"] |
|
|
1632
|
-
stop: str |
|
|
1633
|
-
voice_settings: action_speak_params.VoiceSettings |
|
|
1629
|
+
| Omit = omit,
|
|
1630
|
+
payload_type: Literal["text", "ssml"] | Omit = omit,
|
|
1631
|
+
service_level: Literal["basic", "premium"] | Omit = omit,
|
|
1632
|
+
stop: str | Omit = omit,
|
|
1633
|
+
voice_settings: action_speak_params.VoiceSettings | Omit = omit,
|
|
1634
1634
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1635
1635
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1636
1636
|
extra_headers: Headers | None = None,
|
|
1637
1637
|
extra_query: Query | None = None,
|
|
1638
1638
|
extra_body: Body | None = None,
|
|
1639
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1639
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1640
1640
|
) -> ActionSpeakResponse:
|
|
1641
1641
|
"""Convert text to speech and play it back on the call.
|
|
1642
1642
|
|
|
@@ -1741,20 +1741,20 @@ class ActionsResource(SyncAPIResource):
|
|
|
1741
1741
|
self,
|
|
1742
1742
|
call_control_id: str,
|
|
1743
1743
|
*,
|
|
1744
|
-
assistant: action_start_ai_assistant_params.Assistant |
|
|
1745
|
-
client_state: str |
|
|
1746
|
-
command_id: str |
|
|
1747
|
-
greeting: str |
|
|
1748
|
-
interruption_settings: InterruptionSettingsParam |
|
|
1749
|
-
transcription: TranscriptionConfigParam |
|
|
1750
|
-
voice: str |
|
|
1751
|
-
voice_settings: action_start_ai_assistant_params.VoiceSettings |
|
|
1744
|
+
assistant: action_start_ai_assistant_params.Assistant | Omit = omit,
|
|
1745
|
+
client_state: str | Omit = omit,
|
|
1746
|
+
command_id: str | Omit = omit,
|
|
1747
|
+
greeting: str | Omit = omit,
|
|
1748
|
+
interruption_settings: InterruptionSettingsParam | Omit = omit,
|
|
1749
|
+
transcription: TranscriptionConfigParam | Omit = omit,
|
|
1750
|
+
voice: str | Omit = omit,
|
|
1751
|
+
voice_settings: action_start_ai_assistant_params.VoiceSettings | Omit = omit,
|
|
1752
1752
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1753
1753
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1754
1754
|
extra_headers: Headers | None = None,
|
|
1755
1755
|
extra_query: Query | None = None,
|
|
1756
1756
|
extra_body: Body | None = None,
|
|
1757
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1757
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1758
1758
|
) -> ActionStartAIAssistantResponse:
|
|
1759
1759
|
"""
|
|
1760
1760
|
Start an AI assistant on the call.
|
|
@@ -1846,17 +1846,17 @@ class ActionsResource(SyncAPIResource):
|
|
|
1846
1846
|
self,
|
|
1847
1847
|
call_control_id: str,
|
|
1848
1848
|
*,
|
|
1849
|
-
client_state: str |
|
|
1850
|
-
command_id: str |
|
|
1851
|
-
rx: str |
|
|
1852
|
-
stream_type: Literal["decrypted"] |
|
|
1853
|
-
tx: str |
|
|
1849
|
+
client_state: str | Omit = omit,
|
|
1850
|
+
command_id: str | Omit = omit,
|
|
1851
|
+
rx: str | Omit = omit,
|
|
1852
|
+
stream_type: Literal["decrypted"] | Omit = omit,
|
|
1853
|
+
tx: str | Omit = omit,
|
|
1854
1854
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1855
1855
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1856
1856
|
extra_headers: Headers | None = None,
|
|
1857
1857
|
extra_query: Query | None = None,
|
|
1858
1858
|
extra_body: Body | None = None,
|
|
1859
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1859
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1860
1860
|
) -> ActionStartForkingResponse:
|
|
1861
1861
|
"""
|
|
1862
1862
|
Call forking allows you to stream the media from a call to a specific target in
|
|
@@ -1921,16 +1921,16 @@ class ActionsResource(SyncAPIResource):
|
|
|
1921
1921
|
self,
|
|
1922
1922
|
call_control_id: str,
|
|
1923
1923
|
*,
|
|
1924
|
-
client_state: str |
|
|
1925
|
-
command_id: str |
|
|
1926
|
-
direction: Literal["inbound", "outbound", "both"] |
|
|
1927
|
-
noise_suppression_engine: Literal["A", "B"] |
|
|
1924
|
+
client_state: str | Omit = omit,
|
|
1925
|
+
command_id: str | Omit = omit,
|
|
1926
|
+
direction: Literal["inbound", "outbound", "both"] | Omit = omit,
|
|
1927
|
+
noise_suppression_engine: Literal["A", "B"] | Omit = omit,
|
|
1928
1928
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1929
1929
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1930
1930
|
extra_headers: Headers | None = None,
|
|
1931
1931
|
extra_query: Query | None = None,
|
|
1932
1932
|
extra_body: Body | None = None,
|
|
1933
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1933
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1934
1934
|
) -> ActionStartNoiseSuppressionResponse:
|
|
1935
1935
|
"""
|
|
1936
1936
|
Noise Suppression Start (BETA)
|
|
@@ -1978,23 +1978,23 @@ class ActionsResource(SyncAPIResource):
|
|
|
1978
1978
|
self,
|
|
1979
1979
|
call_control_id: str,
|
|
1980
1980
|
*,
|
|
1981
|
-
audio_type: Literal["mp3", "wav"] |
|
|
1982
|
-
audio_url: str |
|
|
1983
|
-
cache_audio: bool |
|
|
1984
|
-
client_state: str |
|
|
1985
|
-
command_id: str |
|
|
1986
|
-
loop: LoopcountParam |
|
|
1987
|
-
media_name: str |
|
|
1988
|
-
overlay: bool |
|
|
1989
|
-
playback_content: str |
|
|
1990
|
-
stop: str |
|
|
1991
|
-
target_legs: str |
|
|
1981
|
+
audio_type: Literal["mp3", "wav"] | Omit = omit,
|
|
1982
|
+
audio_url: str | Omit = omit,
|
|
1983
|
+
cache_audio: bool | Omit = omit,
|
|
1984
|
+
client_state: str | Omit = omit,
|
|
1985
|
+
command_id: str | Omit = omit,
|
|
1986
|
+
loop: LoopcountParam | Omit = omit,
|
|
1987
|
+
media_name: str | Omit = omit,
|
|
1988
|
+
overlay: bool | Omit = omit,
|
|
1989
|
+
playback_content: str | Omit = omit,
|
|
1990
|
+
stop: str | Omit = omit,
|
|
1991
|
+
target_legs: str | Omit = omit,
|
|
1992
1992
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
1993
1993
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
1994
1994
|
extra_headers: Headers | None = None,
|
|
1995
1995
|
extra_query: Query | None = None,
|
|
1996
1996
|
extra_body: Body | None = None,
|
|
1997
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
1997
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
1998
1998
|
) -> ActionStartPlaybackResponse:
|
|
1999
1999
|
"""Play an audio file on the call.
|
|
2000
2000
|
|
|
@@ -2094,15 +2094,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
2094
2094
|
*,
|
|
2095
2095
|
channels: Literal["single", "dual"],
|
|
2096
2096
|
format: Literal["wav", "mp3"],
|
|
2097
|
-
client_state: str |
|
|
2098
|
-
command_id: str |
|
|
2099
|
-
custom_file_name: str |
|
|
2100
|
-
max_length: int |
|
|
2101
|
-
play_beep: bool |
|
|
2102
|
-
recording_track: Literal["both", "inbound", "outbound"] |
|
|
2103
|
-
timeout_secs: int |
|
|
2104
|
-
transcription: bool |
|
|
2105
|
-
transcription_engine: str |
|
|
2097
|
+
client_state: str | Omit = omit,
|
|
2098
|
+
command_id: str | Omit = omit,
|
|
2099
|
+
custom_file_name: str | Omit = omit,
|
|
2100
|
+
max_length: int | Omit = omit,
|
|
2101
|
+
play_beep: bool | Omit = omit,
|
|
2102
|
+
recording_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
2103
|
+
timeout_secs: int | Omit = omit,
|
|
2104
|
+
transcription: bool | Omit = omit,
|
|
2105
|
+
transcription_engine: str | Omit = omit,
|
|
2106
2106
|
transcription_language: Literal[
|
|
2107
2107
|
"af-ZA",
|
|
2108
2108
|
"am-ET",
|
|
@@ -2250,18 +2250,18 @@ class ActionsResource(SyncAPIResource):
|
|
|
2250
2250
|
"zh-TW",
|
|
2251
2251
|
"zu-ZA",
|
|
2252
2252
|
]
|
|
2253
|
-
|
|
|
2254
|
-
transcription_max_speaker_count: int |
|
|
2255
|
-
transcription_min_speaker_count: int |
|
|
2256
|
-
transcription_profanity_filter: bool |
|
|
2257
|
-
transcription_speaker_diarization: bool |
|
|
2258
|
-
trim: Literal["trim-silence"] |
|
|
2253
|
+
| Omit = omit,
|
|
2254
|
+
transcription_max_speaker_count: int | Omit = omit,
|
|
2255
|
+
transcription_min_speaker_count: int | Omit = omit,
|
|
2256
|
+
transcription_profanity_filter: bool | Omit = omit,
|
|
2257
|
+
transcription_speaker_diarization: bool | Omit = omit,
|
|
2258
|
+
trim: Literal["trim-silence"] | Omit = omit,
|
|
2259
2259
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2260
2260
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2261
2261
|
extra_headers: Headers | None = None,
|
|
2262
2262
|
extra_query: Query | None = None,
|
|
2263
2263
|
extra_body: Body | None = None,
|
|
2264
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2264
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2265
2265
|
) -> ActionStartRecordingResponse:
|
|
2266
2266
|
"""Start recording the call.
|
|
2267
2267
|
|
|
@@ -2369,19 +2369,19 @@ class ActionsResource(SyncAPIResource):
|
|
|
2369
2369
|
self,
|
|
2370
2370
|
call_control_id: str,
|
|
2371
2371
|
*,
|
|
2372
|
-
client_state: str |
|
|
2373
|
-
connector_name: str |
|
|
2374
|
-
include_metadata_custom_headers: Literal[True, False] |
|
|
2375
|
-
secure: Literal[True, False] |
|
|
2376
|
-
session_timeout_secs: int |
|
|
2377
|
-
sip_transport: Literal["udp", "tcp", "tls"] |
|
|
2378
|
-
siprec_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
2372
|
+
client_state: str | Omit = omit,
|
|
2373
|
+
connector_name: str | Omit = omit,
|
|
2374
|
+
include_metadata_custom_headers: Literal[True, False] | Omit = omit,
|
|
2375
|
+
secure: Literal[True, False] | Omit = omit,
|
|
2376
|
+
session_timeout_secs: int | Omit = omit,
|
|
2377
|
+
sip_transport: Literal["udp", "tcp", "tls"] | Omit = omit,
|
|
2378
|
+
siprec_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
2379
2379
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2380
2380
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2381
2381
|
extra_headers: Headers | None = None,
|
|
2382
2382
|
extra_query: Query | None = None,
|
|
2383
2383
|
extra_body: Body | None = None,
|
|
2384
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2384
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2385
2385
|
) -> ActionStartSiprecResponse:
|
|
2386
2386
|
"""
|
|
2387
2387
|
Start siprec session to configured in SIPREC connector SRS.
|
|
@@ -2447,22 +2447,22 @@ class ActionsResource(SyncAPIResource):
|
|
|
2447
2447
|
self,
|
|
2448
2448
|
call_control_id: str,
|
|
2449
2449
|
*,
|
|
2450
|
-
client_state: str |
|
|
2451
|
-
command_id: str |
|
|
2452
|
-
dialogflow_config: DialogflowConfigParam |
|
|
2453
|
-
enable_dialogflow: bool |
|
|
2454
|
-
stream_bidirectional_codec: StreamBidirectionalCodec |
|
|
2455
|
-
stream_bidirectional_mode: StreamBidirectionalMode |
|
|
2456
|
-
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs |
|
|
2457
|
-
stream_codec: StreamCodec |
|
|
2458
|
-
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
2459
|
-
stream_url: str |
|
|
2450
|
+
client_state: str | Omit = omit,
|
|
2451
|
+
command_id: str | Omit = omit,
|
|
2452
|
+
dialogflow_config: DialogflowConfigParam | Omit = omit,
|
|
2453
|
+
enable_dialogflow: bool | Omit = omit,
|
|
2454
|
+
stream_bidirectional_codec: StreamBidirectionalCodec | Omit = omit,
|
|
2455
|
+
stream_bidirectional_mode: StreamBidirectionalMode | Omit = omit,
|
|
2456
|
+
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs | Omit = omit,
|
|
2457
|
+
stream_codec: StreamCodec | Omit = omit,
|
|
2458
|
+
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
2459
|
+
stream_url: str | Omit = omit,
|
|
2460
2460
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2461
2461
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2462
2462
|
extra_headers: Headers | None = None,
|
|
2463
2463
|
extra_query: Query | None = None,
|
|
2464
2464
|
extra_body: Body | None = None,
|
|
2465
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2465
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2466
2466
|
) -> ActionStartStreamingResponse:
|
|
2467
2467
|
"""
|
|
2468
2468
|
Start streaming the media from a call to a specific WebSocket address or
|
|
@@ -2533,17 +2533,17 @@ class ActionsResource(SyncAPIResource):
|
|
|
2533
2533
|
self,
|
|
2534
2534
|
call_control_id: str,
|
|
2535
2535
|
*,
|
|
2536
|
-
client_state: str |
|
|
2537
|
-
command_id: str |
|
|
2538
|
-
transcription_engine: Literal["A", "B"] |
|
|
2539
|
-
transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig |
|
|
2540
|
-
transcription_tracks: str |
|
|
2536
|
+
client_state: str | Omit = omit,
|
|
2537
|
+
command_id: str | Omit = omit,
|
|
2538
|
+
transcription_engine: Literal["A", "B"] | Omit = omit,
|
|
2539
|
+
transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig | Omit = omit,
|
|
2540
|
+
transcription_tracks: str | Omit = omit,
|
|
2541
2541
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2542
2542
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2543
2543
|
extra_headers: Headers | None = None,
|
|
2544
2544
|
extra_query: Query | None = None,
|
|
2545
2545
|
extra_body: Body | None = None,
|
|
2546
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2546
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2547
2547
|
) -> ActionStartTranscriptionResponse:
|
|
2548
2548
|
"""Start real-time transcription.
|
|
2549
2549
|
|
|
@@ -2601,14 +2601,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
2601
2601
|
self,
|
|
2602
2602
|
call_control_id: str,
|
|
2603
2603
|
*,
|
|
2604
|
-
client_state: str |
|
|
2605
|
-
command_id: str |
|
|
2604
|
+
client_state: str | Omit = omit,
|
|
2605
|
+
command_id: str | Omit = omit,
|
|
2606
2606
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2607
2607
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2608
2608
|
extra_headers: Headers | None = None,
|
|
2609
2609
|
extra_query: Query | None = None,
|
|
2610
2610
|
extra_body: Body | None = None,
|
|
2611
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2611
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2612
2612
|
) -> ActionStopAIAssistantResponse:
|
|
2613
2613
|
"""
|
|
2614
2614
|
Stop an AI assistant on the call.
|
|
@@ -2649,15 +2649,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
2649
2649
|
self,
|
|
2650
2650
|
call_control_id: str,
|
|
2651
2651
|
*,
|
|
2652
|
-
client_state: str |
|
|
2653
|
-
command_id: str |
|
|
2654
|
-
stream_type: Literal["raw", "decrypted"] |
|
|
2652
|
+
client_state: str | Omit = omit,
|
|
2653
|
+
command_id: str | Omit = omit,
|
|
2654
|
+
stream_type: Literal["raw", "decrypted"] | Omit = omit,
|
|
2655
2655
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2656
2656
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2657
2657
|
extra_headers: Headers | None = None,
|
|
2658
2658
|
extra_query: Query | None = None,
|
|
2659
2659
|
extra_body: Body | None = None,
|
|
2660
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2660
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2661
2661
|
) -> ActionStopForkingResponse:
|
|
2662
2662
|
"""
|
|
2663
2663
|
Stop forking a call.
|
|
@@ -2708,14 +2708,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
2708
2708
|
self,
|
|
2709
2709
|
call_control_id: str,
|
|
2710
2710
|
*,
|
|
2711
|
-
client_state: str |
|
|
2712
|
-
command_id: str |
|
|
2711
|
+
client_state: str | Omit = omit,
|
|
2712
|
+
command_id: str | Omit = omit,
|
|
2713
2713
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2714
2714
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2715
2715
|
extra_headers: Headers | None = None,
|
|
2716
2716
|
extra_query: Query | None = None,
|
|
2717
2717
|
extra_body: Body | None = None,
|
|
2718
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2718
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2719
2719
|
) -> ActionStopGatherResponse:
|
|
2720
2720
|
"""
|
|
2721
2721
|
Stop current gather.
|
|
@@ -2762,14 +2762,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
2762
2762
|
self,
|
|
2763
2763
|
call_control_id: str,
|
|
2764
2764
|
*,
|
|
2765
|
-
client_state: str |
|
|
2766
|
-
command_id: str |
|
|
2765
|
+
client_state: str | Omit = omit,
|
|
2766
|
+
command_id: str | Omit = omit,
|
|
2767
2767
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2768
2768
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2769
2769
|
extra_headers: Headers | None = None,
|
|
2770
2770
|
extra_query: Query | None = None,
|
|
2771
2771
|
extra_body: Body | None = None,
|
|
2772
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2772
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2773
2773
|
) -> ActionStopNoiseSuppressionResponse:
|
|
2774
2774
|
"""
|
|
2775
2775
|
Noise Suppression Stop (BETA)
|
|
@@ -2810,16 +2810,16 @@ class ActionsResource(SyncAPIResource):
|
|
|
2810
2810
|
self,
|
|
2811
2811
|
call_control_id: str,
|
|
2812
2812
|
*,
|
|
2813
|
-
client_state: str |
|
|
2814
|
-
command_id: str |
|
|
2815
|
-
overlay: bool |
|
|
2816
|
-
stop: str |
|
|
2813
|
+
client_state: str | Omit = omit,
|
|
2814
|
+
command_id: str | Omit = omit,
|
|
2815
|
+
overlay: bool | Omit = omit,
|
|
2816
|
+
stop: str | Omit = omit,
|
|
2817
2817
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2818
2818
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2819
2819
|
extra_headers: Headers | None = None,
|
|
2820
2820
|
extra_query: Query | None = None,
|
|
2821
2821
|
extra_body: Body | None = None,
|
|
2822
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2822
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2823
2823
|
) -> ActionStopPlaybackResponse:
|
|
2824
2824
|
"""
|
|
2825
2825
|
Stop audio being played on the call.
|
|
@@ -2873,15 +2873,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
2873
2873
|
self,
|
|
2874
2874
|
call_control_id: str,
|
|
2875
2875
|
*,
|
|
2876
|
-
client_state: str |
|
|
2877
|
-
command_id: str |
|
|
2878
|
-
recording_id: str |
|
|
2876
|
+
client_state: str | Omit = omit,
|
|
2877
|
+
command_id: str | Omit = omit,
|
|
2878
|
+
recording_id: str | Omit = omit,
|
|
2879
2879
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2880
2880
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2881
2881
|
extra_headers: Headers | None = None,
|
|
2882
2882
|
extra_query: Query | None = None,
|
|
2883
2883
|
extra_body: Body | None = None,
|
|
2884
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2884
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2885
2885
|
) -> ActionStopRecordingResponse:
|
|
2886
2886
|
"""
|
|
2887
2887
|
Stop recording the call.
|
|
@@ -2931,14 +2931,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
2931
2931
|
self,
|
|
2932
2932
|
call_control_id: str,
|
|
2933
2933
|
*,
|
|
2934
|
-
client_state: str |
|
|
2935
|
-
command_id: str |
|
|
2934
|
+
client_state: str | Omit = omit,
|
|
2935
|
+
command_id: str | Omit = omit,
|
|
2936
2936
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2937
2937
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2938
2938
|
extra_headers: Headers | None = None,
|
|
2939
2939
|
extra_query: Query | None = None,
|
|
2940
2940
|
extra_body: Body | None = None,
|
|
2941
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2941
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2942
2942
|
) -> ActionStopSiprecResponse:
|
|
2943
2943
|
"""
|
|
2944
2944
|
Stop SIPREC session.
|
|
@@ -2983,15 +2983,15 @@ class ActionsResource(SyncAPIResource):
|
|
|
2983
2983
|
self,
|
|
2984
2984
|
call_control_id: str,
|
|
2985
2985
|
*,
|
|
2986
|
-
client_state: str |
|
|
2987
|
-
command_id: str |
|
|
2988
|
-
stream_id: str |
|
|
2986
|
+
client_state: str | Omit = omit,
|
|
2987
|
+
command_id: str | Omit = omit,
|
|
2988
|
+
stream_id: str | Omit = omit,
|
|
2989
2989
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
2990
2990
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
2991
2991
|
extra_headers: Headers | None = None,
|
|
2992
2992
|
extra_query: Query | None = None,
|
|
2993
2993
|
extra_body: Body | None = None,
|
|
2994
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
2994
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
2995
2995
|
) -> ActionStopStreamingResponse:
|
|
2996
2996
|
"""
|
|
2997
2997
|
Stop streaming a call to a WebSocket.
|
|
@@ -3042,14 +3042,14 @@ class ActionsResource(SyncAPIResource):
|
|
|
3042
3042
|
self,
|
|
3043
3043
|
call_control_id: str,
|
|
3044
3044
|
*,
|
|
3045
|
-
client_state: str |
|
|
3046
|
-
command_id: str |
|
|
3045
|
+
client_state: str | Omit = omit,
|
|
3046
|
+
command_id: str | Omit = omit,
|
|
3047
3047
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3048
3048
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3049
3049
|
extra_headers: Headers | None = None,
|
|
3050
3050
|
extra_query: Query | None = None,
|
|
3051
3051
|
extra_body: Body | None = None,
|
|
3052
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3052
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3053
3053
|
) -> ActionStopTranscriptionResponse:
|
|
3054
3054
|
"""
|
|
3055
3055
|
Stop real-time transcription.
|
|
@@ -3096,7 +3096,7 @@ class ActionsResource(SyncAPIResource):
|
|
|
3096
3096
|
extra_headers: Headers | None = None,
|
|
3097
3097
|
extra_query: Query | None = None,
|
|
3098
3098
|
extra_body: Body | None = None,
|
|
3099
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3099
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3100
3100
|
) -> ActionSwitchSupervisorRoleResponse:
|
|
3101
3101
|
"""Switch the supervisor role for a bridged call.
|
|
3102
3102
|
|
|
@@ -3134,36 +3134,35 @@ class ActionsResource(SyncAPIResource):
|
|
|
3134
3134
|
answering_machine_detection: Literal[
|
|
3135
3135
|
"premium", "detect", "detect_beep", "detect_words", "greeting_end", "disabled"
|
|
3136
3136
|
]
|
|
3137
|
-
|
|
|
3138
|
-
answering_machine_detection_config: action_transfer_params.AnsweringMachineDetectionConfig
|
|
3139
|
-
|
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
webhook_url_method: Literal["POST", "GET"] | NotGiven = NOT_GIVEN,
|
|
3137
|
+
| Omit = omit,
|
|
3138
|
+
answering_machine_detection_config: action_transfer_params.AnsweringMachineDetectionConfig | Omit = omit,
|
|
3139
|
+
audio_url: str | Omit = omit,
|
|
3140
|
+
client_state: str | Omit = omit,
|
|
3141
|
+
command_id: str | Omit = omit,
|
|
3142
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
3143
|
+
early_media: bool | Omit = omit,
|
|
3144
|
+
from_: str | Omit = omit,
|
|
3145
|
+
from_display_name: str | Omit = omit,
|
|
3146
|
+
media_encryption: Literal["disabled", "SRTP", "DTLS"] | Omit = omit,
|
|
3147
|
+
media_name: str | Omit = omit,
|
|
3148
|
+
mute_dtmf: Literal["none", "both", "self", "opposite"] | Omit = omit,
|
|
3149
|
+
park_after_unbridge: str | Omit = omit,
|
|
3150
|
+
sip_auth_password: str | Omit = omit,
|
|
3151
|
+
sip_auth_username: str | Omit = omit,
|
|
3152
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
3153
|
+
sip_transport_protocol: Literal["UDP", "TCP", "TLS"] | Omit = omit,
|
|
3154
|
+
sound_modifications: SoundModificationsParam | Omit = omit,
|
|
3155
|
+
target_leg_client_state: str | Omit = omit,
|
|
3156
|
+
time_limit_secs: int | Omit = omit,
|
|
3157
|
+
timeout_secs: int | Omit = omit,
|
|
3158
|
+
webhook_url: str | Omit = omit,
|
|
3159
|
+
webhook_url_method: Literal["POST", "GET"] | Omit = omit,
|
|
3161
3160
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3162
3161
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3163
3162
|
extra_headers: Headers | None = None,
|
|
3164
3163
|
extra_query: Query | None = None,
|
|
3165
3164
|
extra_body: Body | None = None,
|
|
3166
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3165
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3167
3166
|
) -> ActionTransferResponse:
|
|
3168
3167
|
"""Transfer a call to a new destination.
|
|
3169
3168
|
|
|
@@ -3329,7 +3328,7 @@ class ActionsResource(SyncAPIResource):
|
|
|
3329
3328
|
extra_headers: Headers | None = None,
|
|
3330
3329
|
extra_query: Query | None = None,
|
|
3331
3330
|
extra_body: Body | None = None,
|
|
3332
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3331
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3333
3332
|
) -> ActionUpdateClientStateResponse:
|
|
3334
3333
|
"""
|
|
3335
3334
|
Updates client state
|
|
@@ -3384,38 +3383,38 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3384
3383
|
self,
|
|
3385
3384
|
call_control_id: str,
|
|
3386
3385
|
*,
|
|
3387
|
-
billing_group_id: str |
|
|
3388
|
-
client_state: str |
|
|
3389
|
-
command_id: str |
|
|
3390
|
-
custom_headers: Iterable[CustomSipHeaderParam] |
|
|
3391
|
-
preferred_codecs: Literal["G722,PCMU,PCMA,G729,OPUS,VP8,H264"] |
|
|
3392
|
-
record: Literal["record-from-answer"] |
|
|
3393
|
-
record_channels: Literal["single", "dual"] |
|
|
3394
|
-
record_custom_file_name: str |
|
|
3395
|
-
record_format: Literal["wav", "mp3"] |
|
|
3396
|
-
record_max_length: int |
|
|
3397
|
-
record_timeout_secs: int |
|
|
3398
|
-
record_track: Literal["both", "inbound", "outbound"] |
|
|
3399
|
-
record_trim: Literal["trim-silence"] |
|
|
3400
|
-
send_silence_when_idle: bool |
|
|
3401
|
-
sip_headers: Iterable[SipHeaderParam] |
|
|
3402
|
-
sound_modifications: SoundModificationsParam |
|
|
3403
|
-
stream_bidirectional_codec: StreamBidirectionalCodec |
|
|
3404
|
-
stream_bidirectional_mode: StreamBidirectionalMode |
|
|
3405
|
-
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs |
|
|
3406
|
-
stream_codec: StreamCodec |
|
|
3407
|
-
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
3408
|
-
stream_url: str |
|
|
3409
|
-
transcription: bool |
|
|
3410
|
-
transcription_config: TranscriptionStartRequestParam |
|
|
3411
|
-
webhook_url: str |
|
|
3412
|
-
webhook_url_method: Literal["POST", "GET"] |
|
|
3386
|
+
billing_group_id: str | Omit = omit,
|
|
3387
|
+
client_state: str | Omit = omit,
|
|
3388
|
+
command_id: str | Omit = omit,
|
|
3389
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
3390
|
+
preferred_codecs: Literal["G722,PCMU,PCMA,G729,OPUS,VP8,H264"] | Omit = omit,
|
|
3391
|
+
record: Literal["record-from-answer"] | Omit = omit,
|
|
3392
|
+
record_channels: Literal["single", "dual"] | Omit = omit,
|
|
3393
|
+
record_custom_file_name: str | Omit = omit,
|
|
3394
|
+
record_format: Literal["wav", "mp3"] | Omit = omit,
|
|
3395
|
+
record_max_length: int | Omit = omit,
|
|
3396
|
+
record_timeout_secs: int | Omit = omit,
|
|
3397
|
+
record_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
3398
|
+
record_trim: Literal["trim-silence"] | Omit = omit,
|
|
3399
|
+
send_silence_when_idle: bool | Omit = omit,
|
|
3400
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
3401
|
+
sound_modifications: SoundModificationsParam | Omit = omit,
|
|
3402
|
+
stream_bidirectional_codec: StreamBidirectionalCodec | Omit = omit,
|
|
3403
|
+
stream_bidirectional_mode: StreamBidirectionalMode | Omit = omit,
|
|
3404
|
+
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs | Omit = omit,
|
|
3405
|
+
stream_codec: StreamCodec | Omit = omit,
|
|
3406
|
+
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
3407
|
+
stream_url: str | Omit = omit,
|
|
3408
|
+
transcription: bool | Omit = omit,
|
|
3409
|
+
transcription_config: TranscriptionStartRequestParam | Omit = omit,
|
|
3410
|
+
webhook_url: str | Omit = omit,
|
|
3411
|
+
webhook_url_method: Literal["POST", "GET"] | Omit = omit,
|
|
3413
3412
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3414
3413
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3415
3414
|
extra_headers: Headers | None = None,
|
|
3416
3415
|
extra_query: Query | None = None,
|
|
3417
3416
|
extra_body: Body | None = None,
|
|
3418
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3417
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3419
3418
|
) -> ActionAnswerResponse:
|
|
3420
3419
|
"""Answer an incoming call.
|
|
3421
3420
|
|
|
@@ -3558,20 +3557,20 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3558
3557
|
path_call_control_id: str,
|
|
3559
3558
|
*,
|
|
3560
3559
|
body_call_control_id: str,
|
|
3561
|
-
client_state: str |
|
|
3562
|
-
command_id: str |
|
|
3563
|
-
mute_dtmf: Literal["none", "both", "self", "opposite"] |
|
|
3564
|
-
park_after_unbridge: str |
|
|
3565
|
-
play_ringtone: bool |
|
|
3566
|
-
queue: str |
|
|
3567
|
-
record: Literal["record-from-answer"] |
|
|
3568
|
-
record_channels: Literal["single", "dual"] |
|
|
3569
|
-
record_custom_file_name: str |
|
|
3570
|
-
record_format: Literal["wav", "mp3"] |
|
|
3571
|
-
record_max_length: int |
|
|
3572
|
-
record_timeout_secs: int |
|
|
3573
|
-
record_track: Literal["both", "inbound", "outbound"] |
|
|
3574
|
-
record_trim: Literal["trim-silence"] |
|
|
3560
|
+
client_state: str | Omit = omit,
|
|
3561
|
+
command_id: str | Omit = omit,
|
|
3562
|
+
mute_dtmf: Literal["none", "both", "self", "opposite"] | Omit = omit,
|
|
3563
|
+
park_after_unbridge: str | Omit = omit,
|
|
3564
|
+
play_ringtone: bool | Omit = omit,
|
|
3565
|
+
queue: str | Omit = omit,
|
|
3566
|
+
record: Literal["record-from-answer"] | Omit = omit,
|
|
3567
|
+
record_channels: Literal["single", "dual"] | Omit = omit,
|
|
3568
|
+
record_custom_file_name: str | Omit = omit,
|
|
3569
|
+
record_format: Literal["wav", "mp3"] | Omit = omit,
|
|
3570
|
+
record_max_length: int | Omit = omit,
|
|
3571
|
+
record_timeout_secs: int | Omit = omit,
|
|
3572
|
+
record_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
3573
|
+
record_trim: Literal["trim-silence"] | Omit = omit,
|
|
3575
3574
|
ringtone: Literal[
|
|
3576
3575
|
"at",
|
|
3577
3576
|
"au",
|
|
@@ -3614,15 +3613,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3614
3613
|
"ve",
|
|
3615
3614
|
"za",
|
|
3616
3615
|
]
|
|
3617
|
-
|
|
|
3618
|
-
video_room_context: str |
|
|
3619
|
-
video_room_id: str |
|
|
3616
|
+
| Omit = omit,
|
|
3617
|
+
video_room_context: str | Omit = omit,
|
|
3618
|
+
video_room_id: str | Omit = omit,
|
|
3620
3619
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3621
3620
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3622
3621
|
extra_headers: Headers | None = None,
|
|
3623
3622
|
extra_query: Query | None = None,
|
|
3624
3623
|
extra_body: Body | None = None,
|
|
3625
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3624
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3626
3625
|
) -> ActionBridgeResponse:
|
|
3627
3626
|
"""
|
|
3628
3627
|
Bridge two call control calls.
|
|
@@ -3746,16 +3745,16 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3746
3745
|
call_control_id: str,
|
|
3747
3746
|
*,
|
|
3748
3747
|
queue_name: str,
|
|
3749
|
-
client_state: str |
|
|
3750
|
-
command_id: str |
|
|
3751
|
-
max_size: int |
|
|
3752
|
-
max_wait_time_secs: int |
|
|
3748
|
+
client_state: str | Omit = omit,
|
|
3749
|
+
command_id: str | Omit = omit,
|
|
3750
|
+
max_size: int | Omit = omit,
|
|
3751
|
+
max_wait_time_secs: int | Omit = omit,
|
|
3753
3752
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3754
3753
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3755
3754
|
extra_headers: Headers | None = None,
|
|
3756
3755
|
extra_query: Query | None = None,
|
|
3757
3756
|
extra_body: Body | None = None,
|
|
3758
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3757
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3759
3758
|
) -> ActionEnqueueResponse:
|
|
3760
3759
|
"""
|
|
3761
3760
|
Put the call in a queue.
|
|
@@ -3807,22 +3806,22 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3807
3806
|
self,
|
|
3808
3807
|
call_control_id: str,
|
|
3809
3808
|
*,
|
|
3810
|
-
client_state: str |
|
|
3811
|
-
command_id: str |
|
|
3812
|
-
gather_id: str |
|
|
3813
|
-
initial_timeout_millis: int |
|
|
3814
|
-
inter_digit_timeout_millis: int |
|
|
3815
|
-
maximum_digits: int |
|
|
3816
|
-
minimum_digits: int |
|
|
3817
|
-
terminating_digit: str |
|
|
3818
|
-
timeout_millis: int |
|
|
3819
|
-
valid_digits: str |
|
|
3809
|
+
client_state: str | Omit = omit,
|
|
3810
|
+
command_id: str | Omit = omit,
|
|
3811
|
+
gather_id: str | Omit = omit,
|
|
3812
|
+
initial_timeout_millis: int | Omit = omit,
|
|
3813
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
3814
|
+
maximum_digits: int | Omit = omit,
|
|
3815
|
+
minimum_digits: int | Omit = omit,
|
|
3816
|
+
terminating_digit: str | Omit = omit,
|
|
3817
|
+
timeout_millis: int | Omit = omit,
|
|
3818
|
+
valid_digits: str | Omit = omit,
|
|
3820
3819
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3821
3820
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3822
3821
|
extra_headers: Headers | None = None,
|
|
3823
3822
|
extra_query: Query | None = None,
|
|
3824
3823
|
extra_body: Body | None = None,
|
|
3825
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3824
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3826
3825
|
) -> ActionGatherResponse:
|
|
3827
3826
|
"""
|
|
3828
3827
|
Gather DTMF signals to build interactive menus.
|
|
@@ -3901,25 +3900,25 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
3901
3900
|
call_control_id: str,
|
|
3902
3901
|
*,
|
|
3903
3902
|
parameters: object,
|
|
3904
|
-
assistant: AssistantParam |
|
|
3905
|
-
client_state: str |
|
|
3906
|
-
command_id: str |
|
|
3907
|
-
greeting: str |
|
|
3908
|
-
interruption_settings: InterruptionSettingsParam |
|
|
3909
|
-
language: GoogleTranscriptionLanguage |
|
|
3910
|
-
message_history: Iterable[action_gather_using_ai_params.MessageHistory] |
|
|
3911
|
-
send_message_history_updates: bool |
|
|
3912
|
-
send_partial_results: bool |
|
|
3913
|
-
transcription: TranscriptionConfigParam |
|
|
3914
|
-
user_response_timeout_ms: int |
|
|
3915
|
-
voice: str |
|
|
3916
|
-
voice_settings: action_gather_using_ai_params.VoiceSettings |
|
|
3903
|
+
assistant: AssistantParam | Omit = omit,
|
|
3904
|
+
client_state: str | Omit = omit,
|
|
3905
|
+
command_id: str | Omit = omit,
|
|
3906
|
+
greeting: str | Omit = omit,
|
|
3907
|
+
interruption_settings: InterruptionSettingsParam | Omit = omit,
|
|
3908
|
+
language: GoogleTranscriptionLanguage | Omit = omit,
|
|
3909
|
+
message_history: Iterable[action_gather_using_ai_params.MessageHistory] | Omit = omit,
|
|
3910
|
+
send_message_history_updates: bool | Omit = omit,
|
|
3911
|
+
send_partial_results: bool | Omit = omit,
|
|
3912
|
+
transcription: TranscriptionConfigParam | Omit = omit,
|
|
3913
|
+
user_response_timeout_ms: int | Omit = omit,
|
|
3914
|
+
voice: str | Omit = omit,
|
|
3915
|
+
voice_settings: action_gather_using_ai_params.VoiceSettings | Omit = omit,
|
|
3917
3916
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
3918
3917
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
3919
3918
|
extra_headers: Headers | None = None,
|
|
3920
3919
|
extra_query: Query | None = None,
|
|
3921
3920
|
extra_body: Body | None = None,
|
|
3922
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
3921
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
3923
3922
|
) -> ActionGatherUsingAIResponse:
|
|
3924
3923
|
"""
|
|
3925
3924
|
Gather parameters defined in the request payload using a voice assistant.
|
|
@@ -4049,25 +4048,25 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4049
4048
|
self,
|
|
4050
4049
|
call_control_id: str,
|
|
4051
4050
|
*,
|
|
4052
|
-
audio_url: str |
|
|
4053
|
-
client_state: str |
|
|
4054
|
-
command_id: str |
|
|
4055
|
-
inter_digit_timeout_millis: int |
|
|
4056
|
-
invalid_audio_url: str |
|
|
4057
|
-
invalid_media_name: str |
|
|
4058
|
-
maximum_digits: int |
|
|
4059
|
-
maximum_tries: int |
|
|
4060
|
-
media_name: str |
|
|
4061
|
-
minimum_digits: int |
|
|
4062
|
-
terminating_digit: str |
|
|
4063
|
-
timeout_millis: int |
|
|
4064
|
-
valid_digits: str |
|
|
4051
|
+
audio_url: str | Omit = omit,
|
|
4052
|
+
client_state: str | Omit = omit,
|
|
4053
|
+
command_id: str | Omit = omit,
|
|
4054
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
4055
|
+
invalid_audio_url: str | Omit = omit,
|
|
4056
|
+
invalid_media_name: str | Omit = omit,
|
|
4057
|
+
maximum_digits: int | Omit = omit,
|
|
4058
|
+
maximum_tries: int | Omit = omit,
|
|
4059
|
+
media_name: str | Omit = omit,
|
|
4060
|
+
minimum_digits: int | Omit = omit,
|
|
4061
|
+
terminating_digit: str | Omit = omit,
|
|
4062
|
+
timeout_millis: int | Omit = omit,
|
|
4063
|
+
valid_digits: str | Omit = omit,
|
|
4065
4064
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4066
4065
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4067
4066
|
extra_headers: Headers | None = None,
|
|
4068
4067
|
extra_query: Query | None = None,
|
|
4069
4068
|
extra_body: Body | None = None,
|
|
4070
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4069
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4071
4070
|
) -> ActionGatherUsingAudioResponse:
|
|
4072
4071
|
"""
|
|
4073
4072
|
Play an audio file on the call until the required DTMF signals are gathered to
|
|
@@ -4173,10 +4172,10 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4173
4172
|
*,
|
|
4174
4173
|
payload: str,
|
|
4175
4174
|
voice: str,
|
|
4176
|
-
client_state: str |
|
|
4177
|
-
command_id: str |
|
|
4178
|
-
inter_digit_timeout_millis: int |
|
|
4179
|
-
invalid_payload: str |
|
|
4175
|
+
client_state: str | Omit = omit,
|
|
4176
|
+
command_id: str | Omit = omit,
|
|
4177
|
+
inter_digit_timeout_millis: int | Omit = omit,
|
|
4178
|
+
invalid_payload: str | Omit = omit,
|
|
4180
4179
|
language: Literal[
|
|
4181
4180
|
"arb",
|
|
4182
4181
|
"cmn-CN",
|
|
@@ -4208,22 +4207,22 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4208
4207
|
"sv-SE",
|
|
4209
4208
|
"tr-TR",
|
|
4210
4209
|
]
|
|
4211
|
-
|
|
|
4212
|
-
maximum_digits: int |
|
|
4213
|
-
maximum_tries: int |
|
|
4214
|
-
minimum_digits: int |
|
|
4215
|
-
payload_type: Literal["text", "ssml"] |
|
|
4216
|
-
service_level: Literal["basic", "premium"] |
|
|
4217
|
-
terminating_digit: str |
|
|
4218
|
-
timeout_millis: int |
|
|
4219
|
-
valid_digits: str |
|
|
4220
|
-
voice_settings: action_gather_using_speak_params.VoiceSettings |
|
|
4210
|
+
| Omit = omit,
|
|
4211
|
+
maximum_digits: int | Omit = omit,
|
|
4212
|
+
maximum_tries: int | Omit = omit,
|
|
4213
|
+
minimum_digits: int | Omit = omit,
|
|
4214
|
+
payload_type: Literal["text", "ssml"] | Omit = omit,
|
|
4215
|
+
service_level: Literal["basic", "premium"] | Omit = omit,
|
|
4216
|
+
terminating_digit: str | Omit = omit,
|
|
4217
|
+
timeout_millis: int | Omit = omit,
|
|
4218
|
+
valid_digits: str | Omit = omit,
|
|
4219
|
+
voice_settings: action_gather_using_speak_params.VoiceSettings | Omit = omit,
|
|
4221
4220
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4222
4221
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4223
4222
|
extra_headers: Headers | None = None,
|
|
4224
4223
|
extra_query: Query | None = None,
|
|
4225
4224
|
extra_body: Body | None = None,
|
|
4226
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4225
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4227
4226
|
) -> ActionGatherUsingSpeakResponse:
|
|
4228
4227
|
"""
|
|
4229
4228
|
Convert text to speech and play it on the call until the required DTMF signals
|
|
@@ -4355,14 +4354,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4355
4354
|
self,
|
|
4356
4355
|
call_control_id: str,
|
|
4357
4356
|
*,
|
|
4358
|
-
client_state: str |
|
|
4359
|
-
command_id: str |
|
|
4357
|
+
client_state: str | Omit = omit,
|
|
4358
|
+
command_id: str | Omit = omit,
|
|
4360
4359
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4361
4360
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4362
4361
|
extra_headers: Headers | None = None,
|
|
4363
4362
|
extra_query: Query | None = None,
|
|
4364
4363
|
extra_body: Body | None = None,
|
|
4365
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4364
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4366
4365
|
) -> ActionHangupResponse:
|
|
4367
4366
|
"""
|
|
4368
4367
|
Hang up the call.
|
|
@@ -4410,14 +4409,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4410
4409
|
self,
|
|
4411
4410
|
call_control_id: str,
|
|
4412
4411
|
*,
|
|
4413
|
-
client_state: str |
|
|
4414
|
-
command_id: str |
|
|
4412
|
+
client_state: str | Omit = omit,
|
|
4413
|
+
command_id: str | Omit = omit,
|
|
4415
4414
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4416
4415
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4417
4416
|
extra_headers: Headers | None = None,
|
|
4418
4417
|
extra_query: Query | None = None,
|
|
4419
4418
|
extra_body: Body | None = None,
|
|
4420
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4419
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4421
4420
|
) -> ActionLeaveQueueResponse:
|
|
4422
4421
|
"""
|
|
4423
4422
|
Removes the call from a queue.
|
|
@@ -4458,15 +4457,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4458
4457
|
self,
|
|
4459
4458
|
call_control_id: str,
|
|
4460
4459
|
*,
|
|
4461
|
-
client_state: str |
|
|
4462
|
-
command_id: str |
|
|
4463
|
-
recording_id: str |
|
|
4460
|
+
client_state: str | Omit = omit,
|
|
4461
|
+
command_id: str | Omit = omit,
|
|
4462
|
+
recording_id: str | Omit = omit,
|
|
4464
4463
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4465
4464
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4466
4465
|
extra_headers: Headers | None = None,
|
|
4467
4466
|
extra_query: Query | None = None,
|
|
4468
4467
|
extra_body: Body | None = None,
|
|
4469
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4468
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4470
4469
|
) -> ActionPauseRecordingResponse:
|
|
4471
4470
|
"""Pause recording the call.
|
|
4472
4471
|
|
|
@@ -4516,18 +4515,18 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4516
4515
|
call_control_id: str,
|
|
4517
4516
|
*,
|
|
4518
4517
|
sip_address: str,
|
|
4519
|
-
client_state: str |
|
|
4520
|
-
command_id: str |
|
|
4521
|
-
custom_headers: Iterable[CustomSipHeaderParam] |
|
|
4522
|
-
sip_auth_password: str |
|
|
4523
|
-
sip_auth_username: str |
|
|
4524
|
-
sip_headers: Iterable[SipHeaderParam] |
|
|
4518
|
+
client_state: str | Omit = omit,
|
|
4519
|
+
command_id: str | Omit = omit,
|
|
4520
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
4521
|
+
sip_auth_password: str | Omit = omit,
|
|
4522
|
+
sip_auth_username: str | Omit = omit,
|
|
4523
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
4525
4524
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4526
4525
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4527
4526
|
extra_headers: Headers | None = None,
|
|
4528
4527
|
extra_query: Query | None = None,
|
|
4529
4528
|
extra_body: Body | None = None,
|
|
4530
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4529
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4531
4530
|
) -> ActionReferResponse:
|
|
4532
4531
|
"""Initiate a SIP Refer on a Call Control call.
|
|
4533
4532
|
|
|
@@ -4596,14 +4595,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4596
4595
|
call_control_id: str,
|
|
4597
4596
|
*,
|
|
4598
4597
|
cause: Literal["CALL_REJECTED", "USER_BUSY"],
|
|
4599
|
-
client_state: str |
|
|
4600
|
-
command_id: str |
|
|
4598
|
+
client_state: str | Omit = omit,
|
|
4599
|
+
command_id: str | Omit = omit,
|
|
4601
4600
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4602
4601
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4603
4602
|
extra_headers: Headers | None = None,
|
|
4604
4603
|
extra_query: Query | None = None,
|
|
4605
4604
|
extra_body: Body | None = None,
|
|
4606
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4605
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4607
4606
|
) -> ActionRejectResponse:
|
|
4608
4607
|
"""
|
|
4609
4608
|
Reject an incoming call.
|
|
@@ -4653,15 +4652,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4653
4652
|
self,
|
|
4654
4653
|
call_control_id: str,
|
|
4655
4654
|
*,
|
|
4656
|
-
client_state: str |
|
|
4657
|
-
command_id: str |
|
|
4658
|
-
recording_id: str |
|
|
4655
|
+
client_state: str | Omit = omit,
|
|
4656
|
+
command_id: str | Omit = omit,
|
|
4657
|
+
recording_id: str | Omit = omit,
|
|
4659
4658
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4660
4659
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4661
4660
|
extra_headers: Headers | None = None,
|
|
4662
4661
|
extra_query: Query | None = None,
|
|
4663
4662
|
extra_body: Body | None = None,
|
|
4664
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4663
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4665
4664
|
) -> ActionResumeRecordingResponse:
|
|
4666
4665
|
"""
|
|
4667
4666
|
Resume recording the call.
|
|
@@ -4710,15 +4709,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4710
4709
|
call_control_id: str,
|
|
4711
4710
|
*,
|
|
4712
4711
|
digits: str,
|
|
4713
|
-
client_state: str |
|
|
4714
|
-
command_id: str |
|
|
4715
|
-
duration_millis: int |
|
|
4712
|
+
client_state: str | Omit = omit,
|
|
4713
|
+
command_id: str | Omit = omit,
|
|
4714
|
+
duration_millis: int | Omit = omit,
|
|
4716
4715
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4717
4716
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4718
4717
|
extra_headers: Headers | None = None,
|
|
4719
4718
|
extra_query: Query | None = None,
|
|
4720
4719
|
extra_body: Body | None = None,
|
|
4721
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4720
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4722
4721
|
) -> ActionSendDtmfResponse:
|
|
4723
4722
|
"""Sends DTMF tones from this leg.
|
|
4724
4723
|
|
|
@@ -4775,14 +4774,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4775
4774
|
*,
|
|
4776
4775
|
body: str,
|
|
4777
4776
|
content_type: str,
|
|
4778
|
-
client_state: str |
|
|
4779
|
-
command_id: str |
|
|
4777
|
+
client_state: str | Omit = omit,
|
|
4778
|
+
command_id: str | Omit = omit,
|
|
4780
4779
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4781
4780
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4782
4781
|
extra_headers: Headers | None = None,
|
|
4783
4782
|
extra_query: Query | None = None,
|
|
4784
4783
|
extra_body: Body | None = None,
|
|
4785
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4784
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4786
4785
|
) -> ActionSendSipInfoResponse:
|
|
4787
4786
|
"""
|
|
4788
4787
|
Sends SIP info from this leg.
|
|
@@ -4836,8 +4835,8 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4836
4835
|
*,
|
|
4837
4836
|
payload: str,
|
|
4838
4837
|
voice: str,
|
|
4839
|
-
client_state: str |
|
|
4840
|
-
command_id: str |
|
|
4838
|
+
client_state: str | Omit = omit,
|
|
4839
|
+
command_id: str | Omit = omit,
|
|
4841
4840
|
language: Literal[
|
|
4842
4841
|
"arb",
|
|
4843
4842
|
"cmn-CN",
|
|
@@ -4869,17 +4868,17 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4869
4868
|
"sv-SE",
|
|
4870
4869
|
"tr-TR",
|
|
4871
4870
|
]
|
|
4872
|
-
|
|
|
4873
|
-
payload_type: Literal["text", "ssml"] |
|
|
4874
|
-
service_level: Literal["basic", "premium"] |
|
|
4875
|
-
stop: str |
|
|
4876
|
-
voice_settings: action_speak_params.VoiceSettings |
|
|
4871
|
+
| Omit = omit,
|
|
4872
|
+
payload_type: Literal["text", "ssml"] | Omit = omit,
|
|
4873
|
+
service_level: Literal["basic", "premium"] | Omit = omit,
|
|
4874
|
+
stop: str | Omit = omit,
|
|
4875
|
+
voice_settings: action_speak_params.VoiceSettings | Omit = omit,
|
|
4877
4876
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4878
4877
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4879
4878
|
extra_headers: Headers | None = None,
|
|
4880
4879
|
extra_query: Query | None = None,
|
|
4881
4880
|
extra_body: Body | None = None,
|
|
4882
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4881
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
4883
4882
|
) -> ActionSpeakResponse:
|
|
4884
4883
|
"""Convert text to speech and play it back on the call.
|
|
4885
4884
|
|
|
@@ -4984,20 +4983,20 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
4984
4983
|
self,
|
|
4985
4984
|
call_control_id: str,
|
|
4986
4985
|
*,
|
|
4987
|
-
assistant: action_start_ai_assistant_params.Assistant |
|
|
4988
|
-
client_state: str |
|
|
4989
|
-
command_id: str |
|
|
4990
|
-
greeting: str |
|
|
4991
|
-
interruption_settings: InterruptionSettingsParam |
|
|
4992
|
-
transcription: TranscriptionConfigParam |
|
|
4993
|
-
voice: str |
|
|
4994
|
-
voice_settings: action_start_ai_assistant_params.VoiceSettings |
|
|
4986
|
+
assistant: action_start_ai_assistant_params.Assistant | Omit = omit,
|
|
4987
|
+
client_state: str | Omit = omit,
|
|
4988
|
+
command_id: str | Omit = omit,
|
|
4989
|
+
greeting: str | Omit = omit,
|
|
4990
|
+
interruption_settings: InterruptionSettingsParam | Omit = omit,
|
|
4991
|
+
transcription: TranscriptionConfigParam | Omit = omit,
|
|
4992
|
+
voice: str | Omit = omit,
|
|
4993
|
+
voice_settings: action_start_ai_assistant_params.VoiceSettings | Omit = omit,
|
|
4995
4994
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
4996
4995
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
4997
4996
|
extra_headers: Headers | None = None,
|
|
4998
4997
|
extra_query: Query | None = None,
|
|
4999
4998
|
extra_body: Body | None = None,
|
|
5000
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
4999
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5001
5000
|
) -> ActionStartAIAssistantResponse:
|
|
5002
5001
|
"""
|
|
5003
5002
|
Start an AI assistant on the call.
|
|
@@ -5089,17 +5088,17 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5089
5088
|
self,
|
|
5090
5089
|
call_control_id: str,
|
|
5091
5090
|
*,
|
|
5092
|
-
client_state: str |
|
|
5093
|
-
command_id: str |
|
|
5094
|
-
rx: str |
|
|
5095
|
-
stream_type: Literal["decrypted"] |
|
|
5096
|
-
tx: str |
|
|
5091
|
+
client_state: str | Omit = omit,
|
|
5092
|
+
command_id: str | Omit = omit,
|
|
5093
|
+
rx: str | Omit = omit,
|
|
5094
|
+
stream_type: Literal["decrypted"] | Omit = omit,
|
|
5095
|
+
tx: str | Omit = omit,
|
|
5097
5096
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5098
5097
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5099
5098
|
extra_headers: Headers | None = None,
|
|
5100
5099
|
extra_query: Query | None = None,
|
|
5101
5100
|
extra_body: Body | None = None,
|
|
5102
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5101
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5103
5102
|
) -> ActionStartForkingResponse:
|
|
5104
5103
|
"""
|
|
5105
5104
|
Call forking allows you to stream the media from a call to a specific target in
|
|
@@ -5164,16 +5163,16 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5164
5163
|
self,
|
|
5165
5164
|
call_control_id: str,
|
|
5166
5165
|
*,
|
|
5167
|
-
client_state: str |
|
|
5168
|
-
command_id: str |
|
|
5169
|
-
direction: Literal["inbound", "outbound", "both"] |
|
|
5170
|
-
noise_suppression_engine: Literal["A", "B"] |
|
|
5166
|
+
client_state: str | Omit = omit,
|
|
5167
|
+
command_id: str | Omit = omit,
|
|
5168
|
+
direction: Literal["inbound", "outbound", "both"] | Omit = omit,
|
|
5169
|
+
noise_suppression_engine: Literal["A", "B"] | Omit = omit,
|
|
5171
5170
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5172
5171
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5173
5172
|
extra_headers: Headers | None = None,
|
|
5174
5173
|
extra_query: Query | None = None,
|
|
5175
5174
|
extra_body: Body | None = None,
|
|
5176
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5175
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5177
5176
|
) -> ActionStartNoiseSuppressionResponse:
|
|
5178
5177
|
"""
|
|
5179
5178
|
Noise Suppression Start (BETA)
|
|
@@ -5221,23 +5220,23 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5221
5220
|
self,
|
|
5222
5221
|
call_control_id: str,
|
|
5223
5222
|
*,
|
|
5224
|
-
audio_type: Literal["mp3", "wav"] |
|
|
5225
|
-
audio_url: str |
|
|
5226
|
-
cache_audio: bool |
|
|
5227
|
-
client_state: str |
|
|
5228
|
-
command_id: str |
|
|
5229
|
-
loop: LoopcountParam |
|
|
5230
|
-
media_name: str |
|
|
5231
|
-
overlay: bool |
|
|
5232
|
-
playback_content: str |
|
|
5233
|
-
stop: str |
|
|
5234
|
-
target_legs: str |
|
|
5223
|
+
audio_type: Literal["mp3", "wav"] | Omit = omit,
|
|
5224
|
+
audio_url: str | Omit = omit,
|
|
5225
|
+
cache_audio: bool | Omit = omit,
|
|
5226
|
+
client_state: str | Omit = omit,
|
|
5227
|
+
command_id: str | Omit = omit,
|
|
5228
|
+
loop: LoopcountParam | Omit = omit,
|
|
5229
|
+
media_name: str | Omit = omit,
|
|
5230
|
+
overlay: bool | Omit = omit,
|
|
5231
|
+
playback_content: str | Omit = omit,
|
|
5232
|
+
stop: str | Omit = omit,
|
|
5233
|
+
target_legs: str | Omit = omit,
|
|
5235
5234
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5236
5235
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5237
5236
|
extra_headers: Headers | None = None,
|
|
5238
5237
|
extra_query: Query | None = None,
|
|
5239
5238
|
extra_body: Body | None = None,
|
|
5240
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5239
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5241
5240
|
) -> ActionStartPlaybackResponse:
|
|
5242
5241
|
"""Play an audio file on the call.
|
|
5243
5242
|
|
|
@@ -5337,15 +5336,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5337
5336
|
*,
|
|
5338
5337
|
channels: Literal["single", "dual"],
|
|
5339
5338
|
format: Literal["wav", "mp3"],
|
|
5340
|
-
client_state: str |
|
|
5341
|
-
command_id: str |
|
|
5342
|
-
custom_file_name: str |
|
|
5343
|
-
max_length: int |
|
|
5344
|
-
play_beep: bool |
|
|
5345
|
-
recording_track: Literal["both", "inbound", "outbound"] |
|
|
5346
|
-
timeout_secs: int |
|
|
5347
|
-
transcription: bool |
|
|
5348
|
-
transcription_engine: str |
|
|
5339
|
+
client_state: str | Omit = omit,
|
|
5340
|
+
command_id: str | Omit = omit,
|
|
5341
|
+
custom_file_name: str | Omit = omit,
|
|
5342
|
+
max_length: int | Omit = omit,
|
|
5343
|
+
play_beep: bool | Omit = omit,
|
|
5344
|
+
recording_track: Literal["both", "inbound", "outbound"] | Omit = omit,
|
|
5345
|
+
timeout_secs: int | Omit = omit,
|
|
5346
|
+
transcription: bool | Omit = omit,
|
|
5347
|
+
transcription_engine: str | Omit = omit,
|
|
5349
5348
|
transcription_language: Literal[
|
|
5350
5349
|
"af-ZA",
|
|
5351
5350
|
"am-ET",
|
|
@@ -5493,18 +5492,18 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5493
5492
|
"zh-TW",
|
|
5494
5493
|
"zu-ZA",
|
|
5495
5494
|
]
|
|
5496
|
-
|
|
|
5497
|
-
transcription_max_speaker_count: int |
|
|
5498
|
-
transcription_min_speaker_count: int |
|
|
5499
|
-
transcription_profanity_filter: bool |
|
|
5500
|
-
transcription_speaker_diarization: bool |
|
|
5501
|
-
trim: Literal["trim-silence"] |
|
|
5495
|
+
| Omit = omit,
|
|
5496
|
+
transcription_max_speaker_count: int | Omit = omit,
|
|
5497
|
+
transcription_min_speaker_count: int | Omit = omit,
|
|
5498
|
+
transcription_profanity_filter: bool | Omit = omit,
|
|
5499
|
+
transcription_speaker_diarization: bool | Omit = omit,
|
|
5500
|
+
trim: Literal["trim-silence"] | Omit = omit,
|
|
5502
5501
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5503
5502
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5504
5503
|
extra_headers: Headers | None = None,
|
|
5505
5504
|
extra_query: Query | None = None,
|
|
5506
5505
|
extra_body: Body | None = None,
|
|
5507
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5506
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5508
5507
|
) -> ActionStartRecordingResponse:
|
|
5509
5508
|
"""Start recording the call.
|
|
5510
5509
|
|
|
@@ -5612,19 +5611,19 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5612
5611
|
self,
|
|
5613
5612
|
call_control_id: str,
|
|
5614
5613
|
*,
|
|
5615
|
-
client_state: str |
|
|
5616
|
-
connector_name: str |
|
|
5617
|
-
include_metadata_custom_headers: Literal[True, False] |
|
|
5618
|
-
secure: Literal[True, False] |
|
|
5619
|
-
session_timeout_secs: int |
|
|
5620
|
-
sip_transport: Literal["udp", "tcp", "tls"] |
|
|
5621
|
-
siprec_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
5614
|
+
client_state: str | Omit = omit,
|
|
5615
|
+
connector_name: str | Omit = omit,
|
|
5616
|
+
include_metadata_custom_headers: Literal[True, False] | Omit = omit,
|
|
5617
|
+
secure: Literal[True, False] | Omit = omit,
|
|
5618
|
+
session_timeout_secs: int | Omit = omit,
|
|
5619
|
+
sip_transport: Literal["udp", "tcp", "tls"] | Omit = omit,
|
|
5620
|
+
siprec_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
5622
5621
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5623
5622
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5624
5623
|
extra_headers: Headers | None = None,
|
|
5625
5624
|
extra_query: Query | None = None,
|
|
5626
5625
|
extra_body: Body | None = None,
|
|
5627
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5626
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5628
5627
|
) -> ActionStartSiprecResponse:
|
|
5629
5628
|
"""
|
|
5630
5629
|
Start siprec session to configured in SIPREC connector SRS.
|
|
@@ -5690,22 +5689,22 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5690
5689
|
self,
|
|
5691
5690
|
call_control_id: str,
|
|
5692
5691
|
*,
|
|
5693
|
-
client_state: str |
|
|
5694
|
-
command_id: str |
|
|
5695
|
-
dialogflow_config: DialogflowConfigParam |
|
|
5696
|
-
enable_dialogflow: bool |
|
|
5697
|
-
stream_bidirectional_codec: StreamBidirectionalCodec |
|
|
5698
|
-
stream_bidirectional_mode: StreamBidirectionalMode |
|
|
5699
|
-
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs |
|
|
5700
|
-
stream_codec: StreamCodec |
|
|
5701
|
-
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] |
|
|
5702
|
-
stream_url: str |
|
|
5692
|
+
client_state: str | Omit = omit,
|
|
5693
|
+
command_id: str | Omit = omit,
|
|
5694
|
+
dialogflow_config: DialogflowConfigParam | Omit = omit,
|
|
5695
|
+
enable_dialogflow: bool | Omit = omit,
|
|
5696
|
+
stream_bidirectional_codec: StreamBidirectionalCodec | Omit = omit,
|
|
5697
|
+
stream_bidirectional_mode: StreamBidirectionalMode | Omit = omit,
|
|
5698
|
+
stream_bidirectional_target_legs: StreamBidirectionalTargetLegs | Omit = omit,
|
|
5699
|
+
stream_codec: StreamCodec | Omit = omit,
|
|
5700
|
+
stream_track: Literal["inbound_track", "outbound_track", "both_tracks"] | Omit = omit,
|
|
5701
|
+
stream_url: str | Omit = omit,
|
|
5703
5702
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5704
5703
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5705
5704
|
extra_headers: Headers | None = None,
|
|
5706
5705
|
extra_query: Query | None = None,
|
|
5707
5706
|
extra_body: Body | None = None,
|
|
5708
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5707
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5709
5708
|
) -> ActionStartStreamingResponse:
|
|
5710
5709
|
"""
|
|
5711
5710
|
Start streaming the media from a call to a specific WebSocket address or
|
|
@@ -5776,17 +5775,17 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5776
5775
|
self,
|
|
5777
5776
|
call_control_id: str,
|
|
5778
5777
|
*,
|
|
5779
|
-
client_state: str |
|
|
5780
|
-
command_id: str |
|
|
5781
|
-
transcription_engine: Literal["A", "B"] |
|
|
5782
|
-
transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig |
|
|
5783
|
-
transcription_tracks: str |
|
|
5778
|
+
client_state: str | Omit = omit,
|
|
5779
|
+
command_id: str | Omit = omit,
|
|
5780
|
+
transcription_engine: Literal["A", "B"] | Omit = omit,
|
|
5781
|
+
transcription_engine_config: action_start_transcription_params.TranscriptionEngineConfig | Omit = omit,
|
|
5782
|
+
transcription_tracks: str | Omit = omit,
|
|
5784
5783
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5785
5784
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5786
5785
|
extra_headers: Headers | None = None,
|
|
5787
5786
|
extra_query: Query | None = None,
|
|
5788
5787
|
extra_body: Body | None = None,
|
|
5789
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5788
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5790
5789
|
) -> ActionStartTranscriptionResponse:
|
|
5791
5790
|
"""Start real-time transcription.
|
|
5792
5791
|
|
|
@@ -5844,14 +5843,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5844
5843
|
self,
|
|
5845
5844
|
call_control_id: str,
|
|
5846
5845
|
*,
|
|
5847
|
-
client_state: str |
|
|
5848
|
-
command_id: str |
|
|
5846
|
+
client_state: str | Omit = omit,
|
|
5847
|
+
command_id: str | Omit = omit,
|
|
5849
5848
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5850
5849
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5851
5850
|
extra_headers: Headers | None = None,
|
|
5852
5851
|
extra_query: Query | None = None,
|
|
5853
5852
|
extra_body: Body | None = None,
|
|
5854
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5853
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5855
5854
|
) -> ActionStopAIAssistantResponse:
|
|
5856
5855
|
"""
|
|
5857
5856
|
Stop an AI assistant on the call.
|
|
@@ -5892,15 +5891,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5892
5891
|
self,
|
|
5893
5892
|
call_control_id: str,
|
|
5894
5893
|
*,
|
|
5895
|
-
client_state: str |
|
|
5896
|
-
command_id: str |
|
|
5897
|
-
stream_type: Literal["raw", "decrypted"] |
|
|
5894
|
+
client_state: str | Omit = omit,
|
|
5895
|
+
command_id: str | Omit = omit,
|
|
5896
|
+
stream_type: Literal["raw", "decrypted"] | Omit = omit,
|
|
5898
5897
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5899
5898
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5900
5899
|
extra_headers: Headers | None = None,
|
|
5901
5900
|
extra_query: Query | None = None,
|
|
5902
5901
|
extra_body: Body | None = None,
|
|
5903
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5902
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5904
5903
|
) -> ActionStopForkingResponse:
|
|
5905
5904
|
"""
|
|
5906
5905
|
Stop forking a call.
|
|
@@ -5951,14 +5950,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
5951
5950
|
self,
|
|
5952
5951
|
call_control_id: str,
|
|
5953
5952
|
*,
|
|
5954
|
-
client_state: str |
|
|
5955
|
-
command_id: str |
|
|
5953
|
+
client_state: str | Omit = omit,
|
|
5954
|
+
command_id: str | Omit = omit,
|
|
5956
5955
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
5957
5956
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
5958
5957
|
extra_headers: Headers | None = None,
|
|
5959
5958
|
extra_query: Query | None = None,
|
|
5960
5959
|
extra_body: Body | None = None,
|
|
5961
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
5960
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
5962
5961
|
) -> ActionStopGatherResponse:
|
|
5963
5962
|
"""
|
|
5964
5963
|
Stop current gather.
|
|
@@ -6005,14 +6004,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6005
6004
|
self,
|
|
6006
6005
|
call_control_id: str,
|
|
6007
6006
|
*,
|
|
6008
|
-
client_state: str |
|
|
6009
|
-
command_id: str |
|
|
6007
|
+
client_state: str | Omit = omit,
|
|
6008
|
+
command_id: str | Omit = omit,
|
|
6010
6009
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6011
6010
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6012
6011
|
extra_headers: Headers | None = None,
|
|
6013
6012
|
extra_query: Query | None = None,
|
|
6014
6013
|
extra_body: Body | None = None,
|
|
6015
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6014
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6016
6015
|
) -> ActionStopNoiseSuppressionResponse:
|
|
6017
6016
|
"""
|
|
6018
6017
|
Noise Suppression Stop (BETA)
|
|
@@ -6053,16 +6052,16 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6053
6052
|
self,
|
|
6054
6053
|
call_control_id: str,
|
|
6055
6054
|
*,
|
|
6056
|
-
client_state: str |
|
|
6057
|
-
command_id: str |
|
|
6058
|
-
overlay: bool |
|
|
6059
|
-
stop: str |
|
|
6055
|
+
client_state: str | Omit = omit,
|
|
6056
|
+
command_id: str | Omit = omit,
|
|
6057
|
+
overlay: bool | Omit = omit,
|
|
6058
|
+
stop: str | Omit = omit,
|
|
6060
6059
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6061
6060
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6062
6061
|
extra_headers: Headers | None = None,
|
|
6063
6062
|
extra_query: Query | None = None,
|
|
6064
6063
|
extra_body: Body | None = None,
|
|
6065
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6064
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6066
6065
|
) -> ActionStopPlaybackResponse:
|
|
6067
6066
|
"""
|
|
6068
6067
|
Stop audio being played on the call.
|
|
@@ -6116,15 +6115,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6116
6115
|
self,
|
|
6117
6116
|
call_control_id: str,
|
|
6118
6117
|
*,
|
|
6119
|
-
client_state: str |
|
|
6120
|
-
command_id: str |
|
|
6121
|
-
recording_id: str |
|
|
6118
|
+
client_state: str | Omit = omit,
|
|
6119
|
+
command_id: str | Omit = omit,
|
|
6120
|
+
recording_id: str | Omit = omit,
|
|
6122
6121
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6123
6122
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6124
6123
|
extra_headers: Headers | None = None,
|
|
6125
6124
|
extra_query: Query | None = None,
|
|
6126
6125
|
extra_body: Body | None = None,
|
|
6127
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6126
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6128
6127
|
) -> ActionStopRecordingResponse:
|
|
6129
6128
|
"""
|
|
6130
6129
|
Stop recording the call.
|
|
@@ -6174,14 +6173,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6174
6173
|
self,
|
|
6175
6174
|
call_control_id: str,
|
|
6176
6175
|
*,
|
|
6177
|
-
client_state: str |
|
|
6178
|
-
command_id: str |
|
|
6176
|
+
client_state: str | Omit = omit,
|
|
6177
|
+
command_id: str | Omit = omit,
|
|
6179
6178
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6180
6179
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6181
6180
|
extra_headers: Headers | None = None,
|
|
6182
6181
|
extra_query: Query | None = None,
|
|
6183
6182
|
extra_body: Body | None = None,
|
|
6184
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6183
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6185
6184
|
) -> ActionStopSiprecResponse:
|
|
6186
6185
|
"""
|
|
6187
6186
|
Stop SIPREC session.
|
|
@@ -6226,15 +6225,15 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6226
6225
|
self,
|
|
6227
6226
|
call_control_id: str,
|
|
6228
6227
|
*,
|
|
6229
|
-
client_state: str |
|
|
6230
|
-
command_id: str |
|
|
6231
|
-
stream_id: str |
|
|
6228
|
+
client_state: str | Omit = omit,
|
|
6229
|
+
command_id: str | Omit = omit,
|
|
6230
|
+
stream_id: str | Omit = omit,
|
|
6232
6231
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6233
6232
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6234
6233
|
extra_headers: Headers | None = None,
|
|
6235
6234
|
extra_query: Query | None = None,
|
|
6236
6235
|
extra_body: Body | None = None,
|
|
6237
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6236
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6238
6237
|
) -> ActionStopStreamingResponse:
|
|
6239
6238
|
"""
|
|
6240
6239
|
Stop streaming a call to a WebSocket.
|
|
@@ -6285,14 +6284,14 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6285
6284
|
self,
|
|
6286
6285
|
call_control_id: str,
|
|
6287
6286
|
*,
|
|
6288
|
-
client_state: str |
|
|
6289
|
-
command_id: str |
|
|
6287
|
+
client_state: str | Omit = omit,
|
|
6288
|
+
command_id: str | Omit = omit,
|
|
6290
6289
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6291
6290
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6292
6291
|
extra_headers: Headers | None = None,
|
|
6293
6292
|
extra_query: Query | None = None,
|
|
6294
6293
|
extra_body: Body | None = None,
|
|
6295
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6294
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6296
6295
|
) -> ActionStopTranscriptionResponse:
|
|
6297
6296
|
"""
|
|
6298
6297
|
Stop real-time transcription.
|
|
@@ -6339,7 +6338,7 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6339
6338
|
extra_headers: Headers | None = None,
|
|
6340
6339
|
extra_query: Query | None = None,
|
|
6341
6340
|
extra_body: Body | None = None,
|
|
6342
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6341
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6343
6342
|
) -> ActionSwitchSupervisorRoleResponse:
|
|
6344
6343
|
"""Switch the supervisor role for a bridged call.
|
|
6345
6344
|
|
|
@@ -6379,36 +6378,35 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6379
6378
|
answering_machine_detection: Literal[
|
|
6380
6379
|
"premium", "detect", "detect_beep", "detect_words", "greeting_end", "disabled"
|
|
6381
6380
|
]
|
|
6382
|
-
|
|
|
6383
|
-
answering_machine_detection_config: action_transfer_params.AnsweringMachineDetectionConfig
|
|
6384
|
-
|
|
|
6385
|
-
|
|
6386
|
-
|
|
6387
|
-
|
|
6388
|
-
|
|
6389
|
-
|
|
6390
|
-
|
|
6391
|
-
|
|
6392
|
-
|
|
6393
|
-
|
|
6394
|
-
|
|
6395
|
-
|
|
6396
|
-
|
|
6397
|
-
|
|
6398
|
-
|
|
6399
|
-
|
|
6400
|
-
|
|
6401
|
-
|
|
6402
|
-
|
|
6403
|
-
|
|
6404
|
-
|
|
6405
|
-
webhook_url_method: Literal["POST", "GET"] | NotGiven = NOT_GIVEN,
|
|
6381
|
+
| Omit = omit,
|
|
6382
|
+
answering_machine_detection_config: action_transfer_params.AnsweringMachineDetectionConfig | Omit = omit,
|
|
6383
|
+
audio_url: str | Omit = omit,
|
|
6384
|
+
client_state: str | Omit = omit,
|
|
6385
|
+
command_id: str | Omit = omit,
|
|
6386
|
+
custom_headers: Iterable[CustomSipHeaderParam] | Omit = omit,
|
|
6387
|
+
early_media: bool | Omit = omit,
|
|
6388
|
+
from_: str | Omit = omit,
|
|
6389
|
+
from_display_name: str | Omit = omit,
|
|
6390
|
+
media_encryption: Literal["disabled", "SRTP", "DTLS"] | Omit = omit,
|
|
6391
|
+
media_name: str | Omit = omit,
|
|
6392
|
+
mute_dtmf: Literal["none", "both", "self", "opposite"] | Omit = omit,
|
|
6393
|
+
park_after_unbridge: str | Omit = omit,
|
|
6394
|
+
sip_auth_password: str | Omit = omit,
|
|
6395
|
+
sip_auth_username: str | Omit = omit,
|
|
6396
|
+
sip_headers: Iterable[SipHeaderParam] | Omit = omit,
|
|
6397
|
+
sip_transport_protocol: Literal["UDP", "TCP", "TLS"] | Omit = omit,
|
|
6398
|
+
sound_modifications: SoundModificationsParam | Omit = omit,
|
|
6399
|
+
target_leg_client_state: str | Omit = omit,
|
|
6400
|
+
time_limit_secs: int | Omit = omit,
|
|
6401
|
+
timeout_secs: int | Omit = omit,
|
|
6402
|
+
webhook_url: str | Omit = omit,
|
|
6403
|
+
webhook_url_method: Literal["POST", "GET"] | Omit = omit,
|
|
6406
6404
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
6407
6405
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
6408
6406
|
extra_headers: Headers | None = None,
|
|
6409
6407
|
extra_query: Query | None = None,
|
|
6410
6408
|
extra_body: Body | None = None,
|
|
6411
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6409
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6412
6410
|
) -> ActionTransferResponse:
|
|
6413
6411
|
"""Transfer a call to a new destination.
|
|
6414
6412
|
|
|
@@ -6574,7 +6572,7 @@ class AsyncActionsResource(AsyncAPIResource):
|
|
|
6574
6572
|
extra_headers: Headers | None = None,
|
|
6575
6573
|
extra_query: Query | None = None,
|
|
6576
6574
|
extra_body: Body | None = None,
|
|
6577
|
-
timeout: float | httpx.Timeout | None | NotGiven =
|
|
6575
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
6578
6576
|
) -> ActionUpdateClientStateResponse:
|
|
6579
6577
|
"""
|
|
6580
6578
|
Updates client state
|