PhoneNumberInformation - Amazon Pinpoint SMS and Voice v2 API

PhoneNumberInformation

The information for a phone number, in E.164 format, in an AWS account.

Contents

CreatedTimestamp

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

Type: Timestamp

Required: Yes

DeletionProtectionEnabled

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

Type: Boolean

Required: Yes

IsoCountryCode

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

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: Yes

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.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

Required: Yes

MonthlyLeasingPrice

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

Type: String

Required: Yes

NumberCapabilities

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: SMS | VOICE

Required: Yes

NumberType

The type of phone number.

Type: String

Valid Values: SHORT_CODE | LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR

Required: Yes

OptOutListName

The name of the OptOutList associated with the phone number.

Type: String

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

Pattern: [A-Za-z0-9_-]+

Required: Yes

PhoneNumber

The phone number in E.164 format.

Type: String

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

Pattern: \+?[1-9][0-9]{1,18}

Required: Yes

PhoneNumberArn

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

Type: String

Required: Yes

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

Type: Boolean

Required: Yes

Status

The current status of the phone number.

Type: String

Valid Values: PENDING | ACTIVE | ASSOCIATING | DISASSOCIATING | DELETED

Required: Yes

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.

Type: Boolean

Required: Yes

PhoneNumberId

The unique identifier for the phone number.

Type: String

Required: No

PoolId

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

Type: String

Required: No

RegistrationId

The unique identifier for the registration.

Type: String

Required: No

TwoWayChannelArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: \S+

Required: No

TwoWayChannelRole

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:\S+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: