Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime ]

create-proxy-session

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-proxy-session
--voice-connector-id <value>
--participant-phone-numbers <value>
[--name <value>]
[--expiry-minutes <value>]
--capabilities <value>
[--number-selection-behavior <value>]
[--geo-match-level <value>]
[--geo-match-params <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime voice connector ID.

--participant-phone-numbers (list)

The participant phone numbers.

Syntax:

"string" "string" ...

--name (string)

The name of the proxy session.

--expiry-minutes (integer)

The number of minutes allowed for the proxy session.

--capabilities (list)

The proxy session capabilities.

Syntax:

"string" "string" ...

Where valid values are:
  Voice
  SMS

--number-selection-behavior (string)

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

Possible values:

  • PreferSticky
  • AvoidSticky

--geo-match-level (string)

The preference for matching the country or area code of the proxy phone number with that of the first participant.

Possible values:

  • Country
  • AreaCode

--geo-match-params (structure)

The country and area code for the proxy phone number.

Shorthand Syntax:

Country=string,AreaCode=string

JSON Syntax:

{
  "Country": "string",
  "AreaCode": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a proxy session

The following create-proxy-session example creates a proxy session with voice and SMS capabilities.

aws chime create-proxy-session \
    --voice-connector-id abcdef1ghij2klmno3pqr4 \
    --participant-phone-numbers "+14015550101" "+12065550100" \
    --capabilities "Voice" "SMS"

Output:

{
    "ProxySession": {
        "VoiceConnectorId": "abcdef1ghij2klmno3pqr4",
        "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l",
        "Status": "Open",
        "ExpiryMinutes": 60,
        "Capabilities": [
            "SMS",
            "Voice"
        ],
        "CreatedTimestamp": "2020-04-15T16:10:10.288Z",
        "UpdatedTimestamp": "2020-04-15T16:10:10.288Z",
        "Participants": [
            {
                "PhoneNumber": "+12065550100",
                "ProxyPhoneNumber": "+19135550199"
            },
            {
                "PhoneNumber": "+14015550101",
                "ProxyPhoneNumber": "+19135550199"
            }
        ]
    }
}

For more information, see Proxy Phone Sessions in the Amazon Chime Developer Guide.

Output

ProxySession -> (structure)

The proxy session details.

VoiceConnectorId -> (string)

The Amazon Chime voice connector ID.

ProxySessionId -> (string)

The proxy session ID.

Name -> (string)

The name of the proxy session.

Status -> (string)

The status of the proxy session.

ExpiryMinutes -> (integer)

The number of minutes allowed for the proxy session.

Capabilities -> (list)

The proxy session capabilities.

(string)

CreatedTimestamp -> (timestamp)

The created timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated timestamp, in ISO 8601 format.

EndedTimestamp -> (timestamp)

The ended timestamp, in ISO 8601 format.

Participants -> (list)

The proxy session participants.

(structure)

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

PhoneNumber -> (string)

The participant's phone number.

ProxyPhoneNumber -> (string)

The participant's proxy phone number.

NumberSelectionBehavior -> (string)

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

GeoMatchLevel -> (string)

The preference for matching the country or area code of the proxy phone number with that of the first participant.

GeoMatchParams -> (structure)

The country and area code for the proxy phone number.

Country -> (string)

The country.

AreaCode -> (string)

The area code.