PinpointSMSVoiceV2 / Client / send_text_message

send_text_message#

PinpointSMSVoiceV2.Client.send_text_message(**kwargs)#

Creates a new text message and sends it to a recipient’s phone number.

SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information, see Message Parts per Second (MPS) limits in the Amazon Pinpoint User Guide.

See also: AWS API Documentation

Request Syntax

response = client.send_text_message(
    DestinationPhoneNumber='string',
    OriginationIdentity='string',
    MessageBody='string',
    MessageType='TRANSACTIONAL'|'PROMOTIONAL',
    Keyword='string',
    ConfigurationSetName='string',
    MaxPrice='string',
    TimeToLive=123,
    Context={
        'string': 'string'
    },
    DestinationCountryParameters={
        'string': 'string'
    },
    DryRun=True|False,
    ProtectConfigurationId='string'
)
Parameters:

  • DestinationPhoneNumber (string) –

    [REQUIRED]

    The destination phone number in E.164 format.

  • OriginationIdentity (string) – The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

  • MessageBody (string) – The body of the text message.

  • MessageType (string) – The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

  • Keyword (string) – When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

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

  • MaxPrice (string) – The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

  • TimeToLive (integer) – How long the text message is valid for. 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) –

  • DestinationCountryParameters (dict) –

    This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

    • (string) –

      • (string) –

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

  • ProtectConfigurationId (string) – The unique identifier for the protect configuration.

Return type:

dict

Returns:

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) –

    • MessageId (string) –

      The unique identifier for the message.

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