RemoveMedia

This method removes a media file from a license key.

Endpoint

GET:
https://messaging.esendex.us/Messaging.svc/RemoveMedia?LicenseKey={LICENSEKEY}&MediaId={MEDIAID}

Syntax

RemoveMedia(LicenseKey, MediaID)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
LicenseKey	Your license key.	GUID	True	00000000-0000-0000-0000-000000000000
MediaID	Unique ID of the media file to remove.	Long	True	12345678

Response

Returns: Boolean

Description: Whether the removal was successful or not. This will be true even when the media does not exist.

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

• C#
• Java
• JavaScript
• JSON POST Request
• JSON Response
• PHP with cURL
• Python
• Ruby
• XML POST Request
• XML Response

C#

// https://messaging.esendex.us/Messaging.svc?wsdl was added as a Service Reference and given the name WSDL

using WSDL;

var client = new MessagingClient(MessagingClient.EndpointConfiguration.mms2wsHttpBindingSecure);

// Let's create a media file.
var media = await client.CreateMediaFromUrlAsync(new CreateMediaUrlRequest
{
    Filename = "MyPhoto.jpg",
    LicenseKey = YOUR_LICENSE_KEY,
    Url = "https://esendex.us/img/docs/example.jpg"
});

// Let's remove our media file.
var success = await client.RemoveMediaAsync(YOUR_LICENSE_KEY, media.MediaId);

Console.WriteLine("Media removed: " + success);

Java

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

public final class RemoveMedia {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://messaging.esendex.us/Messaging.svc/RemoveMedia?"
                    + "LicenseKey=00000000-0000-0000-0000-000000000000"
                    + "&MediaID=12471");
            try {
                InputStream in = url.openStream();
                StreamSource source = new StreamSource(in);
                printResult(source);
            } catch (java.io.IOException e) {
            }
        } catch (MalformedURLException e) {
        }
    }

    private static void printResult(Source source) {
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            StreamResult sr = new StreamResult(bos);
            Transformer trans = TransformerFactory.newInstance().newTransformer();
            Properties oprops = new Properties();
            oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperties(oprops);
            trans.transform(source, sr);

            System.out.println("**** Response ******");
            System.out.println(bos.toString());

            bos.close();
            System.out.println();
        } catch (Exception e) {
        }
    }
}

JavaScript

const headers = {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
};

// Let's create a media file.
const url = 'https://messaging.esendex.us/Messaging.svc/CreateMediaFromUrl';
const response = await fetch(url, {
    headers,
    body: JSON.stringify({
        'Filename': 'MyPhoto.jpg',
        'LicenseKey': '00000000-0000-0000-0000-000000000000',
        'Tags': ['Photo'],
        'Url': 'https://esendex.us/img/docs/example.jpg'
    }),
    method: 'POST'
});

const media = await response.json();

// We can use this ID to remove the media later on.
const mediaId = media['MediaId'];

// Let's remove our media file.
const params = new URLSearchParams({
    'LicenseKey': '00000000-0000-0000-0000-000000000000',
    'MediaID': mediaId
});
const url2 = 'https://messaging.esendex.us/Messaging.svc/RemoveMedia?' + params.toString();
const response2 = await fetch(url2, {
    headers
});
const success = await response2.json();

console.log(success);

JSON Response

true

PHP with cURL

<?php

$url = 'https://messaging.esendex.us/Messaging.svc/RemoveMedia?LicenseKey=00000000-0000-0000-0000-000000000000&MediaID=11784';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPGET, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));

$response = curl_exec($ch);
curl_close($ch);

print_r($response);

?>

Python

import httpx

headers = {"Accept": "application/json"}

with httpx.Client(headers=headers) as client:
    # Let's create a media file.
    response = client.post(
        url="https://messaging.esendex.us/Messaging.svc/CreateMediaFromUrl",
        json={
            "Filename": "MyPhoto.jpg",
            "LicenseKey": "00000000-0000-0000-0000-000000000000",
            "Url": "https://esendex.us/img/docs/example.jpg",
        },
    )
    response.raise_for_status()

    if response.text == "":
        raise RuntimeError("The media could not be created.")

    # We can use this ID to remove the media later on.
    media_id = response.json()["MediaId"]

    # Let's remove our media file.
    response = client.get(
        url="https://messaging.esendex.us/Messaging.svc/RemoveMedia",
        params={
            "LicenseKey": "00000000-0000-0000-0000-000000000000",
            "MediaID": media_id,
        },
    )

    print(response.json())

Ruby

require 'json'
require 'net/http'

headers = { Accept: 'application/json', 'Content-Type': 'application/json' }

# Let's create a media file.
uri = URI('https://messaging.esendex.us/Messaging.svc/CreateMediaFromUrl')
data = {
  'Filename': 'MyPhoto.jpg',
  'LicenseKey': '00000000-0000-0000-0000-000000000000',
  'Tags': ['Photo'],
  'Url': 'https://esendex.us/img/docs/example.jpg'
}.to_json
response = Net::HTTP.post(uri, data, headers)
raise response.message if response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
raise 'The media could not be created.' if response.body == ''

# We can use this ID to fetch the media later on.
media_id = JSON.parse(response.body)['MediaId']

# Let's remove our media file.
uri = URI('https://messaging.esendex.us/Messaging.svc/RemoveMedia')
params = {
  'LicenseKey': '00000000-0000-0000-0000-000000000000',
  'MediaId': media_id
}
uri.query = URI.encode_www_form(params)
response = Net::HTTP.get(uri, headers)
raise response.message if response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)

puts JSON.parse(response)

XML Response

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>