In this article we provide examples of calls and responses relative to Extended Audio descriptions jobs in Reach integration flows.
Retrieving catalog item details for an Extended Audio descriptions job
Example of a response after requesting catalog item details for an Extended Audio descriptions job using vendorCatalogItem.get - Kaltura VPaaS API Documentation:
{
"flavorParamsId": 0,
"clearAudioFlavorParamsId": 0,
"outputFormat": "3",
"id": 20692,
"vendorPartnerId": 5484572,
"name": "Extended AD test",
"systemName": "Extended AD test",
"createdAt": 1692433906,
"updatedAt": 1692433906,
"status": 2,
"serviceType": 1,
"serviceFeature": 9,
"turnAroundTime": -1,
"pricing": {
"pricePerUnit": 0,
"priceFunction": "kReachUtils::calcPricePerMinute",
"objectType": "KalturaVendorCatalogItemPricing"
},
"engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
"sourceLanguage": "English",
"allowResubmission": false,
"objectType": "KalturaVendorExtendedAudioDescriptionCatalogItem"
}Adding VTT file - Create an attachment
Example of an API call to create an Attachment asset using attachmentAsset.add - Kaltura VPaaS API Documentation:
curl -X POST https://www.kaltura.com/api_v3/service/attachment_attachmentasset/action/add \
-d "ks=$KALTURA_SESSION" \
-d "entryId=1_eyl6k4e0" \
-d "attachmentAsset[objectType]=KalturaAttachmentAsset" \
-d "attachmentAsset[format]=1" \
-d "attachmentAsset[tags]=AAD" \
-d "attachmentAsset[fileExt]=vtt"Transfer the VTT file to Kaltura
Example of an API call to transfer the VTT file to Kaltura using attachmentAsset.setContent - Kaltura VPaaS API Documentation:
curl -X POST https://www.kaltura.com/api_v3/service/attachment_attachmentasset/action/setContent \
-d "ks=$KALTURA_SESSION" \
-d "id=978675" \
-d "contentResource[objectType]=KalturaUrlResource" \
-d "contentResource[forceAsyncDownload]=false" \
-d "contentResource[url]=https%3A%2F%2Fwww.vendor.com%2Fdeliverable_to_upload.txt"
