Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendWhatsAppMessage

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

Request Syntax


POST /v1/whatsapp/send HTTP/1.1
Content-type: application/json

{
   "message": blob,
   "metaApiVersion": "string",
   "originationPhoneNumberId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

message

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.

Type: Base64-encoded binary data object

Length Constraints: Minimum length of 1. Maximum length of 2048000.

Required: Yes

metaApiVersion

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

Type: String

Required: Yes

originationPhoneNumberId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "messageId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

messageId

The unique identifier of the message.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400