Class: Aws::PinpointSMSVoiceV2::Types::CarrierLookupRequest

Inherits:

Struct

Object
Struct
Aws::PinpointSMSVoiceV2::Types::CarrierLookupRequest

show all

Defined in:: gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#enable_cleansing ⇒ Boolean
Specifies whether the service cleanses the phone number that you provide.
#phone_number ⇒ String
The phone number that you want to retrieve information about.

Instance Attribute Details

#enable_cleansing ⇒ `Boolean`

Specifies whether the service cleanses the phone number that you provide. When set to true, the service normalizes the phone number according to the destination country's national numbering plan and dialing rules. The service returns the cleansed number in E.164 format in the E164PhoneNumber field and returns the number that you provided in the OriginalPhoneNumber field.

Returns:

(Boolean)

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

class CarrierLookupRequest < Struct.new(
  :phone_number,
  :enable_cleansing)
  SENSITIVE = []
  include Aws::Structure
end

#phone_number ⇒ `String`

The phone number that you want to retrieve information about. You can provide the phone number in various formats including special characters such as parentheses, brackets, spaces, hyphens, periods, and commas. The service automatically converts the input to E164 format for processing.