PinpointSMSVoiceV2 / Client / send_notify_text_message

send_notify_text_message

PinpointSMSVoiceV2.Client.send_notify_text_message(**kwargs)

Sends a templated text message through a notify configuration to a recipient’s phone number.

See also: AWS API Documentation

Request Syntax

response = client.send_notify_text_message(
    NotifyConfigurationId='string',
    DestinationPhoneNumber='string',
    TemplateId='string',
    TemplateVariables={
        'string': 'string'
    },
    TimeToLive=123,
    Context={
        'string': 'string'
    },
    ConfigurationSetName='string',
    DryRun=True|False,
    MessageFeedbackEnabled=True|False
)
Parameters:

  • NotifyConfigurationId (string) –

    [REQUIRED]

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

  • DestinationPhoneNumber (string) –

    [REQUIRED]

    The destination phone number in E.164 format.

  • TemplateId (string) – The unique identifier of the template to use for the message.

  • TemplateVariables (dict) –

    [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".

    • (string) –

      • (string) –

  • TimeToLive (integer) – How long the text message is valid for, in seconds. By default this is 72 hours.

  • Context (dict) –

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

    • (string) –

      • (string) –

  • ConfigurationSetName (string) – The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

  • DryRun (boolean) – When set to true, the message is checked and validated, but isn’t sent to the end recipient.

  • MessageFeedbackEnabled (boolean) – Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

Return type:

dict

Returns:

Response Syntax

{
    'MessageId': 'string',
    'TemplateId': 'string',
    'ResolvedMessageBody': 'string'
}

Response Structure

  • (dict) –

    • MessageId (string) –

      The unique identifier for the message.

    • TemplateId (string) –

      The unique identifier of the template used for the message.

    • ResolvedMessageBody (string) –

      The message body after template variable substitution has been applied.

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.ConflictException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException