Skip to content

Sends a templated voice message through a notify configuration to a recipient's phone number

Description

Sends a templated voice message through a notify configuration to a recipient's phone number.

Usage

pinpointsmsvoicev2_send_notify_voice_message(NotifyConfigurationId,
  DestinationPhoneNumber, TemplateId, TemplateVariables, VoiceId,
  TimeToLive, Context, ConfigurationSetName, DryRun,
  MessageFeedbackEnabled)

Arguments

  • NotifyConfigurationId

    [required] The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.

  • DestinationPhoneNumber

    [required] The destination phone number in E.164 format.

  • TemplateId

    The unique identifier of the template to use for the message.

  • TemplateVariables

    [required] A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".

  • VoiceId

    The voice ID to use for the voice message.

  • TimeToLive

    How long the voice message is valid for, in seconds. By default this is 72 hours.

  • Context

    You can specify custom data in this field. If you do, that data is logged to the event destination.

  • ConfigurationSetName

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

  • DryRun

    When set to true, the message is checked and validated, but isn't sent to the end recipient.

  • MessageFeedbackEnabled

    Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using put_message_feedback.

Value

A list with the following syntax:

list(
  MessageId = "string",
  TemplateId = "string",
  ResolvedMessageBody = "string"
)

Request syntax

svc$send_notify_voice_message(
  NotifyConfigurationId = "string",
  DestinationPhoneNumber = "string",
  TemplateId = "string",
  TemplateVariables = list(
    "string"
  ),
  VoiceId = "AMY"|"ASTRID"|"BIANCA"|"BRIAN"|"CAMILA"|"CARLA"|"CARMEN"|"CELINE"|"CHANTAL"|"CONCHITA"|"CRISTIANO"|"DORA"|"EMMA"|"ENRIQUE"|"EWA"|"FILIZ"|"GERAINT"|"GIORGIO"|"GWYNETH"|"HANS"|"INES"|"IVY"|"JACEK"|"JAN"|"JOANNA"|"JOEY"|"JUSTIN"|"KARL"|"KENDRA"|"KIMBERLY"|"LEA"|"LIV"|"LOTTE"|"LUCIA"|"LUPE"|"MADS"|"MAJA"|"MARLENE"|"MATHIEU"|"MATTHEW"|"MAXIM"|"MIA"|"MIGUEL"|"MIZUKI"|"NAJA"|"NICOLE"|"PENELOPE"|"RAVEENA"|"RICARDO"|"RUBEN"|"RUSSELL"|"SALLI"|"SEOYEON"|"TAKUMI"|"TATYANA"|"VICKI"|"VITORIA"|"ZEINA"|"ZHIYU",
  TimeToLive = 123,
  Context = list(
    "string"
  ),
  ConfigurationSetName = "string",
  DryRun = TRUE|FALSE,
  MessageFeedbackEnabled = TRUE|FALSE
)