PhoneNumber

A phone number used to call an Amazon Chime SDK Voice Connector.

Associations

The phone number's associations.

Type: Array of PhoneNumberAssociation objects

Required: No

CallingName

The outbound calling name associated with the phone number.

Type: String

Pattern: ^$|^[a-zA-Z0-9 ]{2,15}$

Required: No

CallingNameStatus

The outbound calling name status.

Type: String

Valid Values: Unassigned | UpdateInProgress | UpdateSucceeded | UpdateFailed

Required: No

Capabilities

The phone number's capabilities.

Type: PhoneNumberCapabilities object

Required: No

Country

The phone number's country. Format: ISO 3166-1 alpha-2.

Type: String

Pattern: [A-Z]{2}

Required: No

CreatedTimestamp

The phone number creation timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

DeletionTimestamp

The deleted phone number timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

E164PhoneNumber

The phone number, in E.164 format.

Type: String

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

Required: No

Name

The name of the phone number.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: ^$|^[a-zA-Z0-9\,\.\_\-]+(\s+[a-zA-Z0-9\,\.\_\-]+)*$

Required: No

OrderId

The phone number's order ID.

Type: String

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: No

PhoneNumberId

The phone number's ID.

Type: String

Pattern: .*\S.*

Required: No

ProductType

The phone number's product type.

Type: String

Valid Values: VoiceConnector | SipMediaApplicationDialIn

Required: No

Status

The phone number's status.

Type: String

Required: No

Type

The phone number's type.

Type: String

Valid Values: Local | TollFree

Required: No

UpdatedTimestamp

The updated phone number timestamp, in ISO 8601 format.

Type: Timestamp

Required: No

PhoneNumber

Contents

See Also