Send Destination Number Verification Code

pinpointsmsvoicev2_send_destination_number_verification_code

R Documentation

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number¶

Description¶

Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use verify_destination_number to opt-in the verified destination phone number to receive messages.

Usage¶

pinpointsmsvoicev2_send_destination_number_verification_code(
  VerifiedDestinationNumberId, VerificationChannel, LanguageCode,
  OriginationIdentity, ConfigurationSetName, Context,
  DestinationCountryParameters)

Arguments¶

VerifiedDestinationNumberId

[required] The unique identifier for the verified destination phone number.

VerificationChannel

[required] Choose to send the verification code as an SMS or voice message.

LanguageCode

Choose the language to use for the message.

OriginationIdentity

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

ConfigurationSetName

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Context

You can specify custom data in this field. If you do, that data is logged to the event destination.

DestinationCountryParameters

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Value¶

A list with the following syntax:

list(
  MessageId = "string"
)

Request syntax¶

svc$send_destination_number_verification_code(
  VerifiedDestinationNumberId = "string",
  VerificationChannel = "TEXT"|"VOICE",
  LanguageCode = "DE_DE"|"EN_GB"|"EN_US"|"ES_419"|"ES_ES"|"FR_CA"|"FR_FR"|"IT_IT"|"JA_JP"|"KO_KR"|"PT_BR"|"ZH_CN"|"ZH_TW",
  OriginationIdentity = "string",
  ConfigurationSetName = "string",
  Context = list(
    "string"
  ),
  DestinationCountryParameters = list(
    "string"
  )
)