Request Phone Number
pinpointsmsvoicev2_request_phone_number | R Documentation |
Request an origination phone number for use in your account¶
Description¶
Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
Usage¶
pinpointsmsvoicev2_request_phone_number(IsoCountryCode, MessageType,
NumberCapabilities, NumberType, OptOutListName, PoolId, RegistrationId,
DeletionProtectionEnabled, Tags, ClientToken)
Arguments¶
IsoCountryCode
[required] The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MessageType
[required] 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.
NumberCapabilities
[required] Indicates if the phone number will be used for text messages, voice messages, or both.
NumberType
[required] The type of phone number to request.
OptOutListName
The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
PoolId
The pool to associated with the phone number. You can use the PoolId or PoolArn.
RegistrationId
Use this field to attach your phone number for an external registration process.
DeletionProtectionEnabled
By default this is set to false. When set to true the phone number can't be deleted.
Tags
An array of tags (key and value pairs) associate with the requested phone number.
ClientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
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 = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
MonthlyLeasingPrice = "string",
TwoWayEnabled = TRUE|FALSE,
TwoWayChannelArn = "string",
TwoWayChannelRole = "string",
SelfManagedOptOutsEnabled = TRUE|FALSE,
OptOutListName = "string",
DeletionProtectionEnabled = TRUE|FALSE,
PoolId = "string",
RegistrationId = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
CreatedTimestamp = as.POSIXct(
"2015-01-01"
)
)
Request syntax¶
svc$request_phone_number(
IsoCountryCode = "string",
MessageType = "TRANSACTIONAL"|"PROMOTIONAL",
NumberCapabilities = list(
"SMS"|"VOICE"|"MMS"
),
NumberType = "LONG_CODE"|"TOLL_FREE"|"TEN_DLC"|"SIMULATOR",
OptOutListName = "string",
PoolId = "string",
RegistrationId = "string",
DeletionProtectionEnabled = TRUE|FALSE,
Tags = list(
list(
Key = "string",
Value = "string"
)
),
ClientToken = "string"
)