Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateProxySession

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

Request Syntax


POST /voice-connectors/voiceConnectorId/proxy-sessions HTTP/1.1
Content-type: application/json

{
   "Capabilities": [ "string" ],
   "ExpiryMinutes": number,
   "GeoMatchLevel": "string",
   "GeoMatchParams": { 
      "AreaCode": "string",
      "Country": "string"
   },
   "Name": "string",
   "NumberSelectionBehavior": "string",
   "ParticipantPhoneNumbers": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

voiceConnectorId

The Voice Connector ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Capabilities

The proxy session's capabilities.

Type: Array of strings

Valid Values: Voice | SMS

Required: Yes

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 | AreaCode

Required: 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

Pattern: ^$|^[a-zA-Z0-9 ]{0,30}$

Required: No

NumberSelectionBehavior

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

Type: String

Valid Values: PreferSticky | AvoidSticky

Required: No

ParticipantPhoneNumbers

The participant phone numbers.

Type: Array of strings

Array Members: Fixed number of 2 items.

Pattern: ^\+?[1-9]\d{1,14}$

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "ProxySession": { 
      "Capabilities": [ "string" ],
      "CreatedTimestamp": "string",
      "EndedTimestamp": "string",
      "ExpiryMinutes": number,
      "GeoMatchLevel": "string",
      "GeoMatchParams": { 
         "AreaCode": "string",
         "Country": "string"
      },
      "Name": "string",
      "NumberSelectionBehavior": "string",
      "Participants": [ 
         { 
            "PhoneNumber": "string",
            "ProxyPhoneNumber": "string"
         }
      ],
      "ProxySessionId": "string",
      "Status": "string",
      "UpdatedTimestamp": "string",
      "VoiceConnectorId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

ProxySession

The proxy session details.

Type: ProxySession object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401