Difference between revisions of "API Download Recording Video"

From IVS Wiki
Jump to: navigation, search
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This API returns a URL to download a video for a specified recording.
 
This API returns a URL to download a video for a specified recording.
  
−
===Resource URL===
+
===Request URL===
 
<pre>http://valt.example.com/api/v3/records/download/{recordID}/{videoID}</pre>
 
<pre>http://valt.example.com/api/v3/records/download/{recordID}/{videoID}</pre>
−
''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.''
+
''A record's videos' IDs may be obtained from the [[API Recording Details]] request.''
−
 
 
  
 
===Resource Information===
 
===Resource Information===
Line 15: Line 14:
 
|-
 
|-
 
|'''Authentication Required'''
 
|'''Authentication Required'''
−
|Yes
+
|Yes (access token as a query parameter)
 
|}
 
|}
−
''Authentication is performed by obtaining an access token from the [[API Authentication]] request. This token needs to be appended to the suffix of the request URL.''
+
''Authentication is performed with an access token obtained from the [[API Authentication]] request.''
  
  
−
===Parameters===
+
==Request Parameters==
−
No parameters can be passed to this call.
+
===Path Parameters===
 +
{|class="wikitable"
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|'''recordID'''
 +
|string
 +
|ID of the recording to download
 +
|-
 +
|'''videoID'''
 +
|string
 +
|ID of the video to download
 +
|}
 +
 
 +
===Query Parameters===
 +
{|class="wikitable"
 +
!Name
 +
!Type
 +
!Description
 +
|-
 +
|'''access_token'''
 +
|string
 +
|Token used for authentication. Must be appended to the request URL.
 +
|}
 +
 
 +
===Headers===
 +
No headers are required for this request.
 +
 
 +
===Body===
 +
No payloads can be passed to this request.
  
  
−
===Response===
+
==Response==
 +
===HTTP Code===
 
{|class="wikitable"
 
{|class="wikitable"
−
!HTTP Code
+
!Code
 
!Reason
 
!Reason
 
|-
 
|-
Line 36: Line 66:
 
|-
 
|-
 
|404
 
|404
−
|Recording ID or Video ID Not Found
+
|Record ID or Video ID Not Found
 
|}
 
|}
  
 +
===JSON Body===
 
{|class="wikitable"
 
{|class="wikitable"
−
|+JSON Response
 
 
!colspan="2"|data
 
!colspan="2"|data
 
|-
 
|-
 
|'''url'''
 
|'''url'''
−
|Download URL
+
|Download URL of the video file
 
|}
 
|}
 +
  
 
==Examples==
 
==Examples==
Line 53: Line 84:
 
===Successful Response===
 
===Successful Response===
 
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
 
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
 +
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 61: Line 93:
 
===Failure Responses===
 
===Failure Responses===
 
Sample responses are shown with line breaks to make it more readable. Actual responses will not include line breaks.
 
Sample responses are shown with line breaks to make it more readable. Actual responses will not include line breaks.
 +
====Record ID or Video ID not found====
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 70: Line 103:
 
</nowiki>
 
</nowiki>
  
 +
====Unauthorized====
 
  <nowiki>
 
  <nowiki>
 
{
 
{

Latest revision as of 10:47, 8 May 2025

This API returns a URL to download a video for a specified recording.

Request URL

http://valt.example.com/api/v3/records/download/{recordID}/{videoID}

A record's videos' IDs may be obtained from the API Recording Details request.

Resource Information

Method GET
Response Type JSON
Authentication Required Yes (access token as a query parameter)

Authentication is performed with an access token obtained from the API Authentication request.


Request Parameters

Path Parameters

Name Type Description
recordID string ID of the recording to download
videoID string ID of the video to download

Query Parameters

Name Type Description
access_token string Token used for authentication. Must be appended to the request URL.

Headers

No headers are required for this request.

Body

No payloads can be passed to this request.


Response

HTTP Code

Code Reason
200 Request Successful
401 Unauthorized
404 Record ID or Video ID Not Found

JSON Body

data
url Download URL of the video file


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.

Record ID or Video ID not found

{
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"title": "An error occurred",
"status": 404,
"detail": "Not Found"
}

Unauthorized

{
"error":{
"code":401,
"message":"No API key provided"
}
}


{
"error":{
"code": 401,
"message": "Bad credentials."
}
}
Retrieved from "https://ipivs.info/wiki/index.php?title=API_Download_Recording_Video&oldid=16078"