create_proxy_session
¶
create_proxy_session(
voice_connector_id: VoiceConnectorId,
participant_phone_numbers: ParticipantPhoneNumberList,
capabilities: CapabilityList,
*,
config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
name: Optional[ProxySessionNameString] = None,
expiry_minutes: Optional[PositiveInteger] = None,
number_selection_behavior: Optional[NumberSelectionBehavior] = None,
geo_match_level: Optional[GeoMatchLevel] = None,
geo_match_params: Optional[GeoMatchParams] = None,
) -> CreateProxySessionResponse
Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.
End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.
Parameters:
-
voice_connector_id(VoiceConnectorId) –The Voice Connector ID.
-
participant_phone_numbers(ParticipantPhoneNumberList) –The participant phone numbers.
-
name(Optional[ProxySessionNameString], default:None) –The name of the proxy session.
-
expiry_minutes(Optional[PositiveInteger], default:None) –The number of minutes allowed for the proxy session.
-
capabilities(CapabilityList) –The proxy session's capabilities.
-
number_selection_behavior(Optional[NumberSelectionBehavior], default:None) –The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
-
geo_match_level(Optional[GeoMatchLevel], default:None) –The preference for matching the country or area code of the proxy phone number with that of the first participant.
-
geo_match_params(Optional[GeoMatchParams], default:None) –The country and area code for the proxy phone number.
Raises:
-
BadRequestException–The input parameters don't match the service's restrictions.
-
ForbiddenException–The client is permanently forbidden from making the request.
-
NotFoundException–The requested resource couldn't be found.
-
ServiceFailureException–The service encountered an unexpected error.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottledClientException–The number of customer requests exceeds the request rate limit.
-
UnauthorizedClientException–The client isn't authorized to request a resource.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 | |