API Create Sharing Link

From IVS Wiki
Jump to: navigation, search

This API call will create a sharing link for an existing recording that can be distributed. This link will allow anyone to access the specified recording. The link can be removed at any time.

Resource URL

http://valt.example.com/api/v3/records/{recordingid}/share

Replace {recordingid} with the actual id number of the recording. Recordings are numbered sequentially when added to VALT.

Resource Information

Method POST
Response Type JSON
Authentication Required Yes

Parameters

No parameters are required for this API call but an empty set must be defined.

{ }

Response

Code Reason
200 Request Successful
401 Unauthorized
404 Recording Not Found
JSON Response
data
url Link where the now published video can be accessed by anyone.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/records/614/share?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

{
"data":{
"url": "https://ivstest1.ad.ipivs.com/record/share/6019a1fb8af8e13be8df94f61b1f96a9a538d04f"
}
}

Failure Response

{
"error":{
"code": 404
}
}