You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Pinpoint::Types::SMSChannelRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass SMSChannelRequest data as a hash:

{
  enabled: false,
  sender_id: "__string",
  short_code: "__string",
}

SMS Channel Request

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

If the channel is enabled for sending messages.

Returns:

  • (Boolean)


4922
4923
4924
4925
4926
4927
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4922

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  include Aws::Structure
end

#sender_idString

Sender identifier of your messages.

Returns:

  • (String)


4922
4923
4924
4925
4926
4927
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4922

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  include Aws::Structure
end

#short_codeString

ShortCode registered with phone provider.

Returns:

  • (String)


4922
4923
4924
4925
4926
4927
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4922

class SMSChannelRequest < Struct.new(
  :enabled,
  :sender_id,
  :short_code)
  include Aws::Structure
end