pinpointsmsvoicev2/aws.sdk.kotlin.services.pinpointsmsvoicev2.model/PhoneNumberInformation/Builder

Builder

class Builder

Properties

createdTimestamp

var createdTimestamp: Instant?

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

deletionProtectionEnabled

var deletionProtectionEnabled: Boolean

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

isoCountryCode

var isoCountryCode: String?

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

messageType

var messageType: 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.

monthlyLeasingPrice

var monthlyLeasingPrice: String?

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

numberCapabilities

var numberCapabilities: List<NumberCapability>?

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

numberType

var numberType: NumberType?

The type of phone number.

optOutListName

var optOutListName: String?

The name of the OptOutList associated with the phone number.

phoneNumber

var phoneNumber: String?

The phone number in E.164 format.

phoneNumberArn

var phoneNumberArn: String?

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

phoneNumberId

var phoneNumberId: String?

The unique identifier for the phone number.

poolId

var poolId: String?

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

registrationId

var registrationId: String?

The unique identifier for the registration.

selfManagedOptOutsEnabled

var selfManagedOptOutsEnabled: Boolean

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

status

var status: NumberStatus?

The current status of the phone number.

twoWayChannelArn

var twoWayChannelArn: String?

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

twoWayChannelRole

var twoWayChannelRole: String?

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

twoWayEnabled

var twoWayEnabled: Boolean

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