AWSPinpointTargetingVoiceTemplateRequest

Objective-C

@interface AWSPinpointTargetingVoiceTemplateRequest

Swift

class AWSPinpointTargetingVoiceTemplateRequest

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

  • The text of the script to use in messages that are based on the message template, in plain text format.

    Declaration

    Objective-C

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

    Swift

    var body: String? { get set }

  • A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

    Declaration

    Objective-C

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

    Swift

    var defaultSubstitutions: String? { get set }

  • The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    Declaration

    Objective-C

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

    Swift

    var languageCode: String? { get set }

  • A custom description of the message template.

    Declaration

    Objective-C

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

    Swift

    var templateDescription: String? { get set }

  • The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

    Declaration

    Objective-C

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

    Swift

    var voiceId: String? { get set }

  • As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

    (Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    Declaration

    Objective-C

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

    Swift

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