PUT Existing Channel
Overview
The table below provides key details about the PUT
method for updating a channel.
Update Existing Channel | |
---|---|
Method | PUT |
URL or Endpoint | /api/v1/projectId/channels |
Headers | Authorization |
Content Type | multipart/form-data |
Parameters | projectId |
Request Body | PublicId, Title, Logo |
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 description of the body parameters is as follows:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
PubliId | Yes | string | Public identifier of the channel |
Title | Yes | string | Title of the channel |
Logo | No | string($binary) | URL of channel's logo |
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"publicId": "{channelId}",
"streamId": "{streamId}",
"name": "{streamName}",
"title": "{channelTitle}",
"logo": null,
"streamServer": "rtmp://{streamServerLink]",
"streamKey": "{streamKey}",
"playbackUrl": "",
"liveStatus": "Offline",
"healthStatus": "Unknown",
"inputSource": null
},
"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. |
publicId | string | Returns the public identifier of the channel |
streamId | string | Returns the unique identifier of the live job that handles the live streaming |
name | string | Returns a guid that is randomly generated |
title | string | Returns the title of the channel |
logo | string($binary) | Returns the URL for the channel's logo |
streamServer | string | Returns the RTMP URL of the streaming server where live video streams should be directed for ingestion |
streamKey | string | Returns a unique identifier which is used to authenticate and identify a specific live stream on the streaming platform |
playbackUrl | string | Returns a m3u8 file URL where the livestream can be accessed for playback |
liveStatus | string | Indicate the live status of the channel |
healthStatus | string | Indicate the health status of the channel |
inputSource | string | Returns the location from which the live stream is being streamed |
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