Pinpoint / Client / create_voice_template

create_voice_template#

Pinpoint.Client.create_voice_template(**kwargs)#

Creates a message template for messages that are sent through the voice channel.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_template(
    TemplateName='string',
    VoiceTemplateRequest={
        'Body': 'string',
        'DefaultSubstitutions': 'string',
        'LanguageCode': 'string',
        'tags': {
            'string': 'string'
        },
        'TemplateDescription': 'string',
        'VoiceId': 'string'
    }
)
Parameters:

  • TemplateName (string) –

    [REQUIRED]

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

  • VoiceTemplateRequest (dict) –

    [REQUIRED]

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

    • Body (string) –

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

    • DefaultSubstitutions (string) –

      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.

    • LanguageCode (string) –

      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.

    • tags (dict) –

      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.

      • (string) –

        • (string) –

    • TemplateDescription (string) –

      A custom description of the message template.

    • VoiceId (string) –

      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.

Return type:

dict

Returns:

Response Syntax

{
    'CreateTemplateMessageBody': {
        'Arn': 'string',
        'Message': 'string',
        'RequestID': 'string'
    }
}

Response Structure

  • (dict) –

    The request succeeded and the specified resource was created.

    • CreateTemplateMessageBody (dict) –

      Provides information about a request to create a message template.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the message template that was created.

      • Message (string) –

        The message that’s returned from the API for the request to create the message template.

      • RequestID (string) –

        The unique identifier for the request to create the message template.

Exceptions

  • Pinpoint.Client.exceptions.MethodNotAllowedException

  • Pinpoint.Client.exceptions.TooManyRequestsException

  • Pinpoint.Client.exceptions.BadRequestException

  • Pinpoint.Client.exceptions.InternalServerErrorException

  • Pinpoint.Client.exceptions.ForbiddenException