Class: Aws::PinpointSMSVoiceV2::Types::SendDestinationNumberVerificationCodeRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::SendDestinationNumberVerificationCodeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration_set_name ⇒ String

  The name of the configuration set to use.

• #context ⇒ Hash<String,String>

  You can specify custom data in this field.

• #destination_country_parameters ⇒ Hash<String,String>

  This field is used for any country-specific registration requirements.

• #language_code ⇒ String

  Choose the language to use for the message.

• #origination_identity ⇒ String

  The origination identity of the message.

• #verification_channel ⇒ String

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

• #verified_destination_number_id ⇒ String

  The unique identifier for the verified destination phone number.

Instance Attribute Details

#configuration_set_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#destination_country_parameters ⇒ Hash<String,String>

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].

[1]: docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

Choose the language to use for the message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

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).

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#verification_channel ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#verified_destination_number_id ⇒ String

The unique identifier for the verified destination phone number.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 5613

class SendDestinationNumberVerificationCodeRequest < Struct.new(
  :verified_destination_number_id,
  :verification_channel,
  :language_code,
  :origination_identity,
  :configuration_set_name,
  :context,
  :destination_country_parameters)
  SENSITIVE = []
  include Aws::Structure
end