GET Default Custom Screens
Overview
The table below provides key details about the GET
method to receieve Custom Screens of a Specific Project.
GET Custom Screen | |
---|---|
Method | GET |
URL or Endpoint | /api/v1/projectId /custom-screens |
Headers | Authorization |
Parameters | projectId |
The description of the URL parameter is as follows:
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
The request does not contain the request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 311,
"type": 1,
"typeName": "Prelive",
"source": "https://cdn.vpplayer.tech/{channelId}/live-videos/default-screens/{customScreen}.jpg",
"sourcePath": "live-videos/default-screens/{customScreen}.jpg",
"mimeType": null,
"videoId": null,
"playBackUrl": "https://cdn.vpplayer.tech/{channelId}/live/B404B851-9E5E-493E-B648-B552FE2380E8/index.m3u8",
"thumbnailUrl": "https://cdn.vpplayer.tech/agmipnxb/live-videos/default-screens/{customScreen}.jpg",
"channelId": "chbddmrzju",
"projectId": "agmipnxb"
},
{
"id": 312,
"type": 2,
"typeName": "End",
"source": "https://cdn.vpplayer.tech/{channelId}/live-videos/default-screens/{customScreen}.jpg",
"sourcePath": "live-videos/default-screens/{customScreen}.jpg",
"mimeType": null,
"videoId": null,
"playBackUrl": "https://cdn.vpplayer.tech/{projectId}/live/6688A527-D414-4EFD-AB03-2027CE2AD92B/index.m3u8",
"thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/live-videos/default-screens/{customScreen}.jpg",
"channelId": "chbddmrzjr",
"projectId": "agmipnxb"
},
{
"id": 313,
"type": 3,
"typeName": "Pause",
"source": "https://cdn.vpplayer.tech/{projectId}/live-videos/default-screens/{customScreen}.jpg",
"sourcePath": "live-videos/default-screens/{customScreen}.jpg",
"mimeType": null,
"videoId": null,
"playBackUrl": "https://cdn.vpplayer.tech/{projectId}/live/BB0CB6CC-A7E9-44B4-BCCA-3E54B1E53071/index.m3u8",
"thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/live-videos/default-screens/{customScreen}.jpg",
"channelId": "{channelId}",
"projectId": "{projectId}"
},
{
"id": 314,
"type": 4,
"typeName": "Problem",
"source": "https://cdn.vpplayer.tech/{projectId}/live-videos/default-screens/{customScreen}.jpg",
"sourcePath": "live-videos/default-screens/{customScreen}.jpg",
"mimeType": null,
"videoId": null,
"playBackUrl": "https://cdn.vpplayer.tech/{projectId}/live/FB461A47-45B8-4DF2-A523-0A91E9C81268/index.m3u8",
"thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/live-videos/default-screens/{customScreen}.jpg",
"channelId": "{channelId}",
"projectId": "{projectId}"
}
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
id | integer($int32) | Returns the unique identifier for the custom screen |
type | integer($int32) | Specifies the type of the custom screen. |
typeName | string | Name of the type for the custom screen |
source | string | The URL to access the custom screen image |
sourcePath | string($binary) | The relative path of the source file within the storage system |
mimeType | string | The mime type of the custom screen. |
videoId | string | The unique identifier of the video associated with the custom screen |
playbackUrl | string | The URL for the playback of the video assiciated with the custom screen. |
thumbnailUrl | string | The URL to access the thumbnail image of the custom screen |
channelId | string | The unique identifier of the channel associated with the custom screen. |
projectId | string | The unique identifier of the project associated with the custom screen. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed