Difference between revisions of "API Download Recording Video"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
Line 17: | Line 17: | ||
|Yes | |Yes | ||
|} | |} | ||
− | ''Authentication is performed by obtaining an access token from the [[ | + | ''Authentication is performed by obtaining an access token from the [[API Authentication]] request. This needs to be appended to the suffix of the request URL.'' |
Revision as of 08:39, 8 May 2025
This API returns a URL to download a video for a specified recording.
Contents
Resource URL
http://valt.example.com/api/v3/records/download/{recordID}/{videoID}
Replace {recordID} with the actual ID of the recording. Replace {videoID} with the actual ID of the video. A recording's videos' IDs may be obtained from the API Recording Details request.
Resource Information
Method | GET |
Response Type | JSON |
Authentication Required | Yes |
Authentication is performed by obtaining an access token from the API Authentication request. This needs to be appended to the suffix of the request URL.
Parameters
No parameters can be passed to this call.
Response
HTTP Code | Reason |
---|---|
200 | Request Successful |
401 | Unauthorized |
404 | Recording ID or Video ID Not Found |
data | |
---|---|
url | Download URL |
Examples
Request
https://ivssvdev1.ad.ipivs.com/api/v3/records/download/6ecfe37c-a2e9-4f2d-b56e-847a4e730ed0/d6799d1c-8e0f-4dc6-9483-8f3545fc5ce5?access_token=2407c9d2cfde75c49e5d356ee9f83422
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{ "url": "https://ivssvdev1.ad.ipivs.com:8000/distribution/6ecfe37c-a2e9-4f2d-b56e-847a4e730ed0/1_6ecfe37c-a2e9-4f2d-b56e-847a4e730ed0_1.mp4?filename=Just%2Ba%2Broom%2B%2BTW3304.ad.ipivs.com%2B05-06-2025%2B10-18-AM.mp4&access_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJQUzUxMiIsImtpZCI6ImJiZGUyNTk0LWMxMWYtNGIwMy1hYmQ4LWVlNDhjZjNmNWU5NiJ9.eyJpYXQiOjE3NDY1NjM0MTYsIm5iZiI6MTc0NjU2MzQxNiwiZXhwIjoxNzQ2NTY1MjE2LCJpc3MiOiJpdnNzdmRldjEuYWQuaXBpdnMuY29tIiwic3ViIjoiaXZzc3ZkZXYxLmFkLmlwaXZzLmNvbSIsImF1ZCI6Iml2c3N2ZGV2MS5hZC5pcGl2cy5jb20ifQ.annktWv-ij6BuSGJiobaQ8Cl2yAoPMlhzD7inX7XIpJ6bOQxi2gQJ_3fJPZkNl7-7F2xqydrLMH_A2VJdV6xot2g1_4oxmoUlEKNs_aBmn34YtXkq2wc0uv-MVooOPO9sXEPqWZH8mJOPVbwf11o2ZBACxXd5h28oVlc_4u2xjSQXXm32CheTM_5eHcrwi6NfO74tii5EGbUit6-O0utb971K0jfjD9i8q-XitwSO1D01IakQIwbNcP2dqV9SQSjHvNeP3EEg6DfPo0Hwxf6mpYqHdtPK3bsRxQdpXJtna37SRr1raTUiBPk-Xs5tgoP3dtRfiYEaclqVyirwDWLIYTOGNPTZmsi2GZRC7wWeqc7aXWQh_-ZWeUNZJlrzv7AK_GO7gRHLCUKMBKqkfzIQPMd4cMRWuwSO3NIxspDbP1IYi01VHQUc7me2AOGsRWv1w_52xlxhZv3NU36dgvwmt9a2UDtump_k6pblCPGqlEI5UxxMzLPpm4wMQfqb0U4i5uDmvWZX9CqdfDzr_tafMjSQFDueGYN_O1hUI5gTyKzLN6ePchIezToZbGPugHxLOeMs2LpPuVclGNJMabA6OlzmoaU75QIe60BNIU07pjd4UKXFVgVEtL5cjoNyUKT5yKTuywC45demGxzenFRMwjBiUSSA2M_NRl35msl2y8" }
Failure Responses
Sample responses are shown with line breaks to make it more readable. Actual responses will not include line breaks.
{ "type": "https://tools.ietf.org/html/rfc2616#section-10", "title": "An error occurred", "status": 404, "detail": "Not Found" }
{ "error":{ "code":401, "message":"No API key provided" } }
{ "error":{ "code": 401, "message": "Bad credentials." } }