EndUserMessagingSocial / Client / send_whatsapp_message

send_whatsapp_message#

EndUserMessagingSocial.Client.send_whatsapp_message(**kwargs)#

Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .

See also: AWS API Documentation

Request Syntax

response = client.send_whatsapp_message(
    originationPhoneNumberId='string',
    message=b'bytes',
    metaApiVersion='string'
)
Parameters:

  • originationPhoneNumberId (string) –

    [REQUIRED]

    The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

  • message (bytes) –

    [REQUIRED]

    The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.

  • metaApiVersion (string) –

    [REQUIRED]

    The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

Return type:

dict

Returns:

Response Syntax

{
    'messageId': 'string'
}

Response Structure

  • (dict) –

    • messageId (string) –

      The unique identifier of the message.

Exceptions