[ aws . chime ]

update-phone-number

Description

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-phone-number
--phone-number-id <value>
[--product-type <value>]
[--calling-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--phone-number-id (string)

The phone number ID.

--product-type (string)

The product type.

Possible values:

  • BusinessCalling

  • VoiceConnector

--calling-name (string)

The outbound calling name associated with the phone number.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To update the product type for a phone number

The following update-phone-number example updates the specified phone number’s product type.

aws chime update-phone-number \
    --phone-number-id "+12065550100" \
    --product-type "BusinessCalling"

Output:

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "BusinessCalling",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
        "Associations": [],
        "CallingName": "phonenumber1",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-12T21:44:07.591Z"
    }
}

Example 2: To update the outbound calling name for a phone number

The following update-phone-number example updates the outbound calling name for the specified phone number.

aws chime update-phone-number

–phone-number-id “+12065550100” –calling-name “phonenumber2”

Output:

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "BusinessCalling",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
        "Associations": [],
        "CallingName": "phonenumber2",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-12T21:44:07.591Z"
    }
}

For more information, see Working with Phone Numbers in the Amazon Chime Administration Guide.

Output

PhoneNumber -> (structure)

The updated phone number details.

PhoneNumberId -> (string)

The phone number ID.

E164PhoneNumber -> (string)

The phone number, in E.164 format.

Type -> (string)

The phone number type.

ProductType -> (string)

The phone number product type.

Status -> (string)

The phone number status.

Capabilities -> (structure)

The phone number capabilities.

InboundCall -> (boolean)

Allows or denies inbound calling for the specified phone number.

OutboundCall -> (boolean)

Allows or denies outbound calling for the specified phone number.

InboundSMS -> (boolean)

Allows or denies inbound SMS messaging for the specified phone number.

OutboundSMS -> (boolean)

Allows or denies outbound SMS messaging for the specified phone number.

InboundMMS -> (boolean)

Allows or denies inbound MMS messaging for the specified phone number.

OutboundMMS -> (boolean)

Allows or denies outbound MMS messaging for the specified phone number.

Associations -> (list)

The phone number associations.

(structure)

The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

Value -> (string)

Contains the ID for the entity specified in Name.

Name -> (string)

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

AssociatedTimestamp -> (timestamp)

The timestamp of the phone number association, in ISO 8601 format.

CallingName -> (string)

The outbound calling name associated with the phone number.

CallingNameStatus -> (string)

The outbound calling name status.

CreatedTimestamp -> (timestamp)

The phone number creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated phone number timestamp, in ISO 8601 format.

DeletionTimestamp -> (timestamp)

The deleted phone number timestamp, in ISO 8601 format.