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

PostWhatsAppMessageMedia

Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.

Request Syntax


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

{
   "originationPhoneNumberId": "string",
   "sourceS3File": { 
      "bucketName": "string",
      "key": "string"
   },
   "sourceS3PresignedUrl": { 
      "headers": { 
         "string" : "string" 
      },
      "url": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

originationPhoneNumberId

The ID of the phone number to associate with the WhatsApp media file. The 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

sourceS3File

The source S3 url for the media file.

Type: S3File object

Required: No

sourceS3PresignedUrl

The source presign url of the media file.

Type: S3PresignedUrl object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "mediaId": "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.

mediaId

The unique identifier of the posted WhatsApp message.

Type: String

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

Pattern: [A-Za-z0-9]+

Errors

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

AccessDeniedByMetaException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

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