The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
ProxySession
The proxy session for an Amazon Chime Voice Connector.
Contents
- Capabilities
-
The proxy session capabilities.
Type: Array of strings
Valid Values:
Voice | SMSRequired: No
- CreatedTimestamp
-
The created time stamp, in ISO 8601 format.
Type: Timestamp
Required: No
- EndedTimestamp
-
The ended time stamp, in ISO 8601 format.
Type: Timestamp
Required: No
- ExpiryMinutes
-
The number of minutes allowed for the proxy session.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- GeoMatchLevel
-
The preference for matching the country or area code of the proxy phone number with that of the first participant.
Type: String
Valid Values:
Country | AreaCodeRequired: No
- GeoMatchParams
-
The country and area code for the proxy phone number.
Type: GeoMatchParams object
Required: No
- Name
-
The name of the proxy session.
Type: String
Length Constraints: Maximum length of 128.
Required: No
- NumberSelectionBehavior
-
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
Type: String
Valid Values:
PreferSticky | AvoidStickyRequired: No
- Participants
-
The proxy session participants.
Type: Array of Participant objects
Required: No
- ProxySessionId
-
The proxy session ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
- Status
-
The status of the proxy session.
Type: String
Valid Values:
Open | InProgress | ClosedRequired: No
- UpdatedTimestamp
-
The updated time stamp, in ISO 8601 format.
Type: Timestamp
Required: No
- VoiceConnectorId
-
The Amazon Chime voice connector ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
