Pinpoint SMS and Voice Phone Number

An AWS Pinpoint SMS and Voice Phone Number represents a dedicated phone number that can be used to send SMS messages or make voice calls through Amazon Pinpoint. It provides details such as the number type, capabilities, and region, enabling businesses to manage communication channels for customer engagement and marketing campaigns.

aws.smsvoice_phone_number

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
created_timestampcoretimestampThe time when the phone number was created, in UNIX epoch time format.
deletion_protection_enabledcoreboolWhen set to true the phone number can't be deleted.
iso_country_codecorestringThe two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
message_typecorestringThe 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.
monthly_leasing_pricecorestringThe price, in US dollars, to lease the phone number.
number_capabilitiescorearray<string>Describes if the origination identity can be used for text messages, voice calls or both.
number_typecorestringThe type of phone number.
opt_out_list_namecorestringThe name of the OptOutList associated with the phone number.
phone_numbercorestringThe phone number in E.164 format.
phone_number_arncorestringThe Amazon Resource Name (ARN) associated with the phone number.
phone_number_idcorestringThe unique identifier for the phone number.
pool_idcorestringThe unique identifier of the pool associated with the phone number.
registration_idcorestringThe unique identifier for the registration.
self_managed_opt_outs_enabledcoreboolWhen set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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
statuscorestringThe current status of the phone number.
tagscorehstore
two_way_channel_arncorestringThe Amazon Resource Name (ARN) of the two way channel.
two_way_channel_rolecorestringAn optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
two_way_enabledcoreboolBy default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.