# Clip Message

API call format

GET /broker/clippers/messages/{guid}

Description

This call gets current clipper message by guid.

Precondition

  • Authorization token is not needed.
  • Mandatory elements (should be specified):
    • "guid" - message guid <message_guid> .

Postcondition

  • On success response code should be 200
  • On success the message details is returned in JSON format.
  • The following statuses are expected:
    • executing
    • finished
  • New created source should be found by using Vod list API call.
    • status should be "complete"
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/broker/clippers/messages/<message_guid>
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
	"status": true,
	"data": 
	{
		"guid": "<message_guid>",
		"message": 
		{
			"input": "https://<server>/<path>/master.m3u8",
			"metaData": 
			{
				"encodeNow": 1,           //flag indicates if the clip should be encodded 
				"title": "<clip_title>",
				"name": "<clip_name>"
			},

			"from": 500,
			"to": 512
		},

		"type": "generic_hls",
		"status": "finished",
		"createdAt": 1575385583369,
		"updatedAt": 1575385603023,
		"downloadLink": "https://<amazon_server>/<path>"
	}
}