LIVE PUBLICATION DETAILS


The details property exists for each Live Publication and differs per Target.

For Live, the details property also contains the streaming URLs as an array called ingestionDetails. Typically there are 1 or 2 of these, with one of these marked as Primary. You can view the structure below

  • Add objects can be used to represent the initial data sent into the system when Creating.
  • Update objects can be used to represent the updated data sent into the system when Updating.
  • View objects are returned inside of the PublicationModel, most of these values will be null unless queryTarget is set to True.

Shared

Shared properties can exist on the details object. These can be identified by the lack of a prefix (i.e. fb_, yt_, etc.).

This is useful for working with properties that do not need to respect the Target, such as embedHtml, link or ingestionDetails. Shared properties are not required to exist on every Publication type however - such as Custom lacking the embedHtml and link properties.

IngestionDetails

All RTMP URLs are returned inside a shared object inside of the details object. They are returned in the following structure:

{
    "rtmpServerUrl": "...",
    "rtmpStreamName": "...",
    "rtmpApplicationName": "...",
    "isPrimary": true,
    "isSsl": false
}

Custom

Add Details

{
    "cstm_description": "Custom Description",
    "cstm_streamUrl": "http://server-to-send-to.com",
    "cstm_streamName": "streamKeyGoesHere",
    "cstm_backupStreamUrl": null,
    "cstm_backupStreamName": null,
}

Required: cstm_streamUrl, cstm_streamName

These are not required if the Custom Destination has URLs configured for this Publication to inherit from.

Update Details

{
    "cstm_description": "Custom Description",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

View Details

{
    "cstm_description": "Custom Description",
    "ingestionDetails": []
}

Facebook

Add Details

{
    "fb_title": "Post Title",
    "fb_description": "Post Description",
    "fb_saveVod": true,
    "fb_startTime": "2019-05-19T12:45:00Z",
    "fb_endTime": "2019-05-19T12:55:00Z",
    "fb_contentTags": [
        "my-tag"
    ],
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Required: fb_title

Update Details

{
    "fb_title": "Post Title",
    "fb_description": "Post Description",
    "fb_saveVod": true,
    "fb_startTime": "2019-05-19T12:45:00Z",
    "fb_endTime": "2019-05-19T12:55:00Z",
    "fb_contentTags": [
        "my-tag"
    ],
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

View Details

{
    "fb_title": "Post Title",
    "fb_description": "Post Description",
    "fb_saveVod": true,
    "fb_startTime": "2019-05-19T12:45:00Z",
    "fb_endTime": "2019-05-19T12:55:00Z",
    "fb_contentTags": [
        "my-tag"
    ],
    "fb_resourceId": "2147581300458",
    "fb_status": "LIVE",
    "embedHtml": "",
    "ingestionDetails": []
}

YouTube

Add Details

{
    "yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_startTime": "2019-05-19T12:45:00Z",
    "yt_endTime": "2019-05-19T12:55:00Z",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

Required: yt_title, yt_startTime, yt_privacyStatus

Permitted values for privacy status: public, private, unlisted

Permitted values for ingestion type: rtmp, dash

Update Details

{
    "yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_startTime": "2019-05-19T12:45:00Z",
    "yt_endTime": "2019-05-19T12:55:00Z",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "callbackUrls": [
        "http://my-callback-url.com/Publication/Update"
    ]
}

View Details

{
    "yt_title": "YouTube Video",
    "yt_description": "YouTube Description",
    "yt_startTime": "2019-05-19T12:45:00Z",
    "yt_endTime": "2019-05-19T12:55:00Z",
    "yt_privacyStatus": "unlisted",
    "yt_ingestionType": "rtmp",
    "yt_broadcastId": "29834148",
    "yt_liveStreamId": "655612",
    "ingestionDetails": []
}