Documentation

Overview

The Mogreet platform has fully featured content ingestion, transcoding and serving features to make using audio, images and video in your mobile apps, web and messaging simple and painless.   You never need to know what content container, codec, image size or frame rate is appropriate for a given media device – the Mogreet platform does that for you. You simply ingest a piece of content via an API call, and get back a content id and a URL that resolves to the content. You can use that URL (called a 'smart URL') wherever you need to access the content in a mobile message, application, or on the mobile web.  When a remote mobile device hits the URL, the Mogreet platform reads the device type and profile information, and delivers the optimal version of the content for that device using the most appropriate delivery mechanism.

There are API calls to list all the content you have ingested, to retrieve the Smart URL for a given content id, and to destroy a piece of content hosted in the system.

As usual the easiest way to test the API calls is with curl in a terminal shell. For example, in the command below, if you replace the client id with your own client id and the token with your own token and enter the command in a terminal or shell window:

curl "https://api.mogreet.com/cm/media.list?client_id=123&token=a5d4a59"

You will receive an immediate response back as XML.

You can easily test the media upload with curl as well, using the –F flag to send a file as multipart/form-data:

curl -F "file=@myvideo.mp4" "https://api.mogreet.com/cm/media.upload?client_id=1234&token=e15b909234f6836eab1cb0&type=video&name=VideoCallback"

Remember to replace the "file=" with the name and location of your own file, and to substitute your own client_id and token.  Check the man pages for the unix command 'curl' on line or in your terminal window to learn more about using curl to post files to an API.

You can download a pdf version of the full API reference here: Mogreet Messaging System API 4.01.pdf

List all your ingested Content

media.list

The media list API call takes your client_id and token, and returns an XML formatted response detailing all the items of content that you have ingested, the associated content ids, and the Smart URL used to access the content on a mobile device.

Request:

https://api.mogreet.com/cm/media.list

with the following parameters:

Name Description
client_id Your client id.
token Your token.
format Optional. When set to 'json' the response will be in JSON format rather than XML.

A successful call will return an HTTP 200 with XML response, having the following elements for each media item in the media list:


Element Name Description
content_id A unique integer describing that content master in the Mogreet system. Can be used in other media API calls to modify or delete the content item.
smart_url The URL where this content can be accessed on all devices
name The name of the content item given at the time the content was ingested
type One of: Audio, Video, Image
filename The filename of the file ingested

Response examples:

Request Response
https://api.mogreet.com/cm/media.list?client_id=1234&token=a487b7fba7180573c58e45d4a60
<?xml version="1.0" encoding="UTF-8"?>
<response code="1" status="success">
<message>media list retrieved</message>
<media_list>
<media>
<content_id>149286</content_id>
<smart_url>http://m.mogreet.com/oc/1ombg6q</smart_url>
<name>RetroDemoVideo</name>
<type>video</type>
<filename>5153-myvideo.mp4
</filename>
</media>
</media_list>
</response>
a media.list call returning a JSON result
{
"response":
{
"code": "1",
"status": "success",
"message": "media list retrieved",
"media_list":
[
{"name": "bzola",
"type": "image",
"content_id": "160667",
"smart_url": "http://m.mogreet.com/oc/iunjiw6zs",
"filename": "7605-bzola.jpg"
},
{
"name": "moTest: audio",
"type": "audio",
"content_id": "159632",
"smart_url": "http://m.mogreet.com/oc/iw8enwq60",
"filename": "34-barsanti.mp3"
},
]
}
}