Notify Response Format

<?xml version="1.0"?>
<result>
    <mediaid>[MediaID]</mediaid>
    <source>[SourceFile]</source>
    <status>[MediaStatus]</status>
    <description>[ErrorDescription]</description> <!-- Only present when Status = Error -->
    <format>
        <output>[OutputFormat]</output>
        <destination>[URL]</destination> <!-- Only present when Status = Finished -->
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status> 
        <destination>[URL_2]</destination>
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status>
        <!-- ... -->
        <destination>[URL_N]</destination>
        <destination_status>[Saved|Error (ErrorDescription)]</destination_status>
        <status>[TaskStatus]</status>
        <description>[ErrorDescription]</description> <!-- Only present when Status = Error -->
        <suggestion>[ErrorSuggestion]</suggestion> <!-- Only present when Status = Error -->
        <output_json>
            <!-- output_json data -->
        </output_json>
        <audio_validation>
            <stream_id>[AudioStreamID]</stream_id>
            <alternate_id>[AlternateID]</alternate_id>
            <state>[ValidationStatus]</state>
            <muted_channels>[ChannelNumber1]</muted_channels>
            <muted_channels>[ChannelNumber2]</muted_channels>
            <!-- ... -->
            <muted_channels>[ChannelNumberN]</muted_channels>
            <too_low_level>[ChannelNumber1]</too_low_level>
            <too_low_level>[ChannelNumber2]</too_low_level>
            <!-- ... -->
            <too_low_level>[ChannelNumberN]</too_low_level>
            <stereo_diff>[0|1]</stereo_diff>
            <side_diff>[0|1]</side_diff>
            <high_freq_lfe>[0|1]</high_freq_lfe>
        <audio_validation>
        <audio_validation>
            <!-- audio_validation params -->
        </audio_validation>
    </format>
</result>
{
    "result": {
        "mediaid": "[MediaID]",
        "source": "[SourceFile]",
        "status": "[MediaStatus]",
        "description": "[ErrorDescription]",
        "format": {
            "output": "[OutputFormat]",
            "destination": "[URL]",
            "destination_status": "[Saved|Error (ErrorDescription)]",
            "status": "[TaskStatus]",
            "description": "[ErrorDescription]",
            "suggestion": "[ErrorSuggestion]",
            "output_json": {
                // output_json data
            },
            "audio_validation": [
                {
                    "stream_id": "[AudioStreamID]",
                    "alternate_id": "[AlternateID]",
                    "state": "[ValidationStatus]",
                    "muted_channels": [
                        "[ChannelNumber1]",
                        "[ChannelNumber2]",
                        // ...
                        "[ChannelNumberN]"
                    ],
                    "too_low_level": [
                        "[ChannelNumber1]",
                        "[ChannelNumber2]",
                        // ...
                        "[ChannelNumberN]"
                    ],
                    "stereo_diff": "[0|1]",
                    "side_diff": "[0|1]",
                    "high_freq_lfe": "[0|1]"
                },
                {
                    // audio_validation params
                }
            ]
        }
    }
}
{
    "result": {
        "mediaid": "[MediaID]",
        "source": "[SourceFile]",
        "status": "[MediaStatus]",
        "description": "[ErrorDescription]",
        "format": {
            "output": "[OutputFormat]",
            "destination": [
                "[URL]",
                "[URL_2]",
                "[URL_N]"
            ],
            "destination_status": [
                "[Saved|Error (ErrorDescription)]",
                "[Saved|Error (ErrorDescription)]",
                "[Saved|Error (ErrorDescription)]"
            ],
            "status": "[TaskStatus]",
            "description": "[ErrorDescription]",
            "suggestion": "[ErrorSuggestion]",
            "output_json": {
                // output_json data
            },
            "audio_validation": [
                {
                    "stream_id": "[AudioStreamID]",
                    "alternate_id": "[AlternateID]",
                    "state": "[ValidationStatus]",
                    "muted_channels": [
                        "[ChannelNumber1]",
                        "[ChannelNumber2]",
                        // ...
                        "[ChannelNumberN]"
                    ],
                    "too_low_level": [
                        "[ChannelNumber1]",
                        "[ChannelNumber2]",
                        // ...
                        "[ChannelNumberN]"
                    ],
                    "stereo_diff": "[0|1]",
                    "side_diff": "[0|1]",
                    "high_freq_lfe": "[0|1]"
                },
                {
                    // audio_validation params
                }
            ]
        }
    }
}

🚧

Destinations when using JSON format

If media has only one destination, than destination and destination_status parameters will be presented as a string, otherwise these parameters will be presented as an array, with indices of each destination matching the same index for status.

🚧

For audio_validation

The <audio_validation /> section will be included to the notification data only if
<extended_notify /> media parameter was set to yes.

Paremeter

Description

mediaID

A unique identifier assigned to each new media.

SourceFile

Media source file URL.

MediaStatus

Media Job results are "Finished" or "Error".

OutputFormat

Format of encoded file, as was requested in the query.

URL

Could be one of the following:

ftp://[user]:[password]@[server]/[path]/[filename]

http://[users.bucket].s3.amazonaws.com/[path]/[filename]

— the bucket must have WRITE permission for AWS user 1a85ad8fea02b4d948b962948f69972a72da6bed800a7e9ca7d0b43dc61d5869

See Amazon S3 ACL for details OR the URL below if destination was not specified in the query.

http://[encoding.bucket].s3.amazonaws.com/[path]/[filename]

TaskStatus

Individual task results are "Finished" or "Error".

ErrorDescription

If the job ends in error, an error description is provided.

ErrorSuggestion

If we have a suggested resolution for the error it will be provided here.