EndUserMessagingSocial / Client / delete_whatsapp_media_message

delete_whatsapp_media_message#

EndUserMessagingSocial.Client.delete_whatsapp_media_message(**kwargs)#

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

See also: AWS API Documentation

Request Syntax

response = client.delete_whatsapp_media_message(
    mediaId='string',
    originationPhoneNumberId='string'
)
Parameters:
  • mediaId (string) –

    [REQUIRED]

    The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.

  • originationPhoneNumberId (string) –

    [REQUIRED]

    The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

Return type:

dict

Returns:

Response Syntax

{
    'success': True|False
}

Response Structure

  • (dict) –

    • success (boolean) –

      Success indicator for deleting the media file.

Exceptions