Update Phone Number
pinpointsmsvoicev2_update_phone_number | R Documentation |
Updates the configuration of an existing origination phone number¶
Description¶
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
Usage¶
pinpointsmsvoicev2_update_phone_number(PhoneNumberId, TwoWayEnabled,
TwoWayChannelArn, TwoWayChannelRole, SelfManagedOptOutsEnabled,
OptOutListName, DeletionProtectionEnabled)
Arguments¶
PhoneNumberId
[required] The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
TwoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
TwoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
TwoWayChannelRole
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
SelfManagedOptOutsEnabled
By default this is set to false. When 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 requests.
OptOutListName
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
DeletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
Value¶
A list with the following syntax:
list(
PhoneNumberArn = "string",
PhoneNumberId = "string",
PhoneNumber = "string",
Status = "PENDING"|"ACTIVE"|"ASSOCIATING"|"DISASSOCIATING"|"DELETED",
IsoCountryCode = "string",
MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
NumberCapabilities = list(
"SMS"|"VOICE"|"MMS"
),
NumberType = "SHORT_CODE"|"LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
MonthlyLeasingPrice = "string",
TwoWayEnabled = TRUE|FALSE,
TwoWayChannelArn = "string",
TwoWayChannelRole = "string",
SelfManagedOptOutsEnabled = TRUE|FALSE,
OptOutListName = "string",
DeletionProtectionEnabled = TRUE|FALSE,
RegistrationId = "string",
CreatedTimestamp = as.POSIXct(
"2015-01-01"
)
)