/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the pinpoint-sms-voice-v2-2022-03-31.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.PinpointSMSVoiceV2.Model
{
///
/// Container for the parameters to the SendVoiceMessage operation.
/// Allows you to send a request that sends a text message through Amazon Pinpoint. This
/// operation uses Amazon Polly to convert
/// a text script into a voice message.
///
public partial class SendVoiceMessageRequest : AmazonPinpointSMSVoiceV2Request
{
private string _configurationSetName;
private Dictionary _context = new Dictionary();
private string _destinationPhoneNumber;
private bool? _dryRun;
private string _maxPricePerMinute;
private string _messageBody;
private VoiceMessageBodyTextType _messageBodyTextType;
private string _originationIdentity;
private int? _timeToLive;
private VoiceId _voiceId;
///
/// Gets and sets the property ConfigurationSetName.
///
/// The name of the configuration set to use. This can be either the ConfigurationSetName
/// or ConfigurationSetArn.
///
///
[AWSProperty(Min=1, Max=256)]
public string ConfigurationSetName
{
get { return this._configurationSetName; }
set { this._configurationSetName = value; }
}
// Check to see if ConfigurationSetName property is set
internal bool IsSetConfigurationSetName()
{
return this._configurationSetName != null;
}
///
/// Gets and sets the property Context.
///
/// You can specify custom data in this field. If you do, that data is logged to the event
/// destination.
///
///
[AWSProperty(Min=0, Max=5)]
public Dictionary Context
{
get { return this._context; }
set { this._context = value; }
}
// Check to see if Context property is set
internal bool IsSetContext()
{
return this._context != null && this._context.Count > 0;
}
///
/// Gets and sets the property DestinationPhoneNumber.
///
/// The destination phone number in E.164 format.
///
///
[AWSProperty(Required=true, Min=1, Max=20)]
public string DestinationPhoneNumber
{
get { return this._destinationPhoneNumber; }
set { this._destinationPhoneNumber = value; }
}
// Check to see if DestinationPhoneNumber property is set
internal bool IsSetDestinationPhoneNumber()
{
return this._destinationPhoneNumber != null;
}
///
/// Gets and sets the property DryRun.
///
/// When set to true, the message is checked and validated, but isn't sent to the end
/// recipient.
///
///
public bool DryRun
{
get { return this._dryRun.GetValueOrDefault(); }
set { this._dryRun = value; }
}
// Check to see if DryRun property is set
internal bool IsSetDryRun()
{
return this._dryRun.HasValue;
}
///
/// Gets and sets the property MaxPricePerMinute.
///
/// The maximum amount to spend per voice message, in US dollars.
///
///
[AWSProperty(Min=2, Max=8)]
public string MaxPricePerMinute
{
get { return this._maxPricePerMinute; }
set { this._maxPricePerMinute = value; }
}
// Check to see if MaxPricePerMinute property is set
internal bool IsSetMaxPricePerMinute()
{
return this._maxPricePerMinute != null;
}
///
/// Gets and sets the property MessageBody.
///
/// The text to convert to a voice message.
///
///
[AWSProperty(Min=1, Max=6000)]
public string MessageBody
{
get { return this._messageBody; }
set { this._messageBody = value; }
}
// Check to see if MessageBody property is set
internal bool IsSetMessageBody()
{
return this._messageBody != null;
}
///
/// Gets and sets the property MessageBodyTextType.
///
/// Specifies if the MessageBody field contains text or speech
/// synthesis markup language (SSML).
///
/// -
///
/// TEXT: This is the default value. When used the maximum character limit is 3000.
///
///
-
///
/// SSML: When used the maximum character limit is 6000 including SSML tagging.
///
///
///
public VoiceMessageBodyTextType MessageBodyTextType
{
get { return this._messageBodyTextType; }
set { this._messageBodyTextType = value; }
}
// Check to see if MessageBodyTextType property is set
internal bool IsSetMessageBodyTextType()
{
return this._messageBodyTextType != null;
}
///
/// Gets and sets the property OriginationIdentity.
///
/// The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId,
/// PhoneNumberArn, PoolId, or PoolArn.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string OriginationIdentity
{
get { return this._originationIdentity; }
set { this._originationIdentity = value; }
}
// Check to see if OriginationIdentity property is set
internal bool IsSetOriginationIdentity()
{
return this._originationIdentity != null;
}
///
/// Gets and sets the property TimeToLive.
///
/// How long the voice message is valid for. By default this is 72 hours.
///
///
[AWSProperty(Min=5, Max=259200)]
public int TimeToLive
{
get { return this._timeToLive.GetValueOrDefault(); }
set { this._timeToLive = value; }
}
// Check to see if TimeToLive property is set
internal bool IsSetTimeToLive()
{
return this._timeToLive.HasValue;
}
///
/// Gets and sets the property VoiceId.
///
/// The voice for the Amazon
/// Polly service to use. By default this is set to "MATTHEW".
///
///
public VoiceId VoiceId
{
get { return this._voiceId; }
set { this._voiceId = value; }
}
// Check to see if VoiceId property is set
internal bool IsSetVoiceId()
{
return this._voiceId != null;
}
}
}