AWSPinpointTargetingSMSMessage

Objective-C

@interface AWSPinpointTargetingSMSMessage

Swift

class AWSPinpointTargetingSMSMessage

Specifies the default settings for a one-time SMS message that’s sent directly to an endpoint.

  • The body of the SMS message.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable body;

    Swift

    var body: String? { get set }

  • The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable entityId;

    Swift

    var entityId: String? { get set }

  • The SMS program name that you provided to AWS Support when you requested your dedicated number.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyword;

    Swift

    var keyword: String? { get set }

  • This field is reserved for future use.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable mediaUrl;

    Swift

    var mediaUrl: String? { get set }

  • The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren’t critical or time-sensitive, such as marketing messages).

    Declaration

    Objective-C

    @property (nonatomic) AWSPinpointTargetingMessageType messageType;

    Swift

    var messageType: AWSPinpointTargetingMessageType { get set }

  • The number to send the SMS message from. This value should be one of the dedicated long or short codes that’s assigned to your AWS account. If you don’t specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable originationNumber;

    Swift

    var originationNumber: String? { get set }

  • The sender ID to display as the sender of the message on a recipient’s device. Support for sender IDs varies by country or region.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable senderId;

    Swift

    var senderId: String? { get set }

  • The message variables to use in the SMS message. You can override the default variables with individual address variables.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSArray<NSString *> *> *_Nullable substitutions;

    Swift

    var substitutions: [String : [String]]? { get set }

  • The template ID received from the regulatory body for sending SMS in your country.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateId;

    Swift

    var templateId: String? { get set }