Documentation

The information for a phone number in an Amazon Web Services account.

See: newPhoneNumberInformation smart constructor.

Create a value of PhoneNumberInformation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:phoneNumberId:PhoneNumberInformation', phoneNumberInformation_phoneNumberId - The unique identifier for the phone number.

$sel:poolId:PhoneNumberInformation', phoneNumberInformation_poolId - The unique identifier of the pool associated with the phone number.

$sel:twoWayChannelArn:PhoneNumberInformation', phoneNumberInformation_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

$sel:phoneNumberArn:PhoneNumberInformation', phoneNumberInformation_phoneNumberArn - The Amazon Resource Name (ARN) associated with the phone number.

$sel:phoneNumber:PhoneNumberInformation', phoneNumberInformation_phoneNumber - The phone number in E.164 format.

$sel:status:PhoneNumberInformation', phoneNumberInformation_status - The current status of the phone number.

$sel:isoCountryCode:PhoneNumberInformation', phoneNumberInformation_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

$sel:messageType:PhoneNumberInformation', phoneNumberInformation_messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

$sel:numberCapabilities:PhoneNumberInformation', phoneNumberInformation_numberCapabilities - Describes if the origination identity can be used for text messages, voice calls or both.

$sel:numberType:PhoneNumberInformation', phoneNumberInformation_numberType - The type of phone number.

$sel:monthlyLeasingPrice:PhoneNumberInformation', phoneNumberInformation_monthlyLeasingPrice - The price, in US dollars, to lease the phone number.

$sel:twoWayEnabled:PhoneNumberInformation', phoneNumberInformation_twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

$sel:selfManagedOptOutsEnabled:PhoneNumberInformation', phoneNumberInformation_selfManagedOptOutsEnabled - When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

$sel:optOutListName:PhoneNumberInformation', phoneNumberInformation_optOutListName - The name of the OptOutList associated with the phone number.

$sel:deletionProtectionEnabled:PhoneNumberInformation', phoneNumberInformation_deletionProtectionEnabled - When set to true the phone number can't be deleted.

$sel:createdTimestamp:PhoneNumberInformation', phoneNumberInformation_createdTimestamp - The time when the phone number was created, in UNIX epoch time format.

The unique identifier for the phone number.

The unique identifier of the pool associated with the phone number.

The Amazon Resource Name (ARN) of the two way channel.

The Amazon Resource Name (ARN) associated with the phone number.

The phone number in E.164 format.

The current status of the phone number.

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Describes if the origination identity can be used for text messages, voice calls or both.

The type of phone number.

The price, in US dollars, to lease the phone number.

By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

The name of the OptOutList associated with the phone number.

When set to true the phone number can't be deleted.

The time when the phone number was created, in UNIX epoch time format.