Get channel event list

Article summary

Did you find this summary helpful?

Thank you for your feedback

This is an API to get the channel event list.

Request

GET https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/events

Request headers

Header name	Required	Description
x-ncp-apigw-timestamp	YES	This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC, and the request is considered invalid if the timestamp differs from the current time by more than 5 minutes `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	Value of access key ID issued in the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-region_code	YES	Region code (KR)

Response

Field name	Type	Description
logLevel	String	INFO, ERROR
eventCode	String
description	String
timestamp	Integer

Event code details

eventCode	logLevel	Type	Description
STREAM_RESERVE	INFO	String	Channel created
STREAM_UPDATE	INFO	String	Channel settings updated
PUBLISH_END	INFO	String	Channel streaming ended
PUBLISH_START	INFO	String	Channel streaming started
THUMBNAIL_CREATE	INFO	String	Channel thumbnail created
SIMULCAST_STATUS_CHANGE	INFO	String	Target platform status updated
ONAIR_START	INFO	String	Channel recording started
ONAIR_END	INFO	String	Channel recording ended
PUBLISH_OVER_THRESHOLD	INFO	String	Bitrate coming into the channel exceeded the threshold and sent out
RTMP_MAIN_STREAM_ENABLED	INFO	String	Main streaming enabled
RTMP_BACKUP_STREAM_ENABLED	INFO	String	Main stream switched to backup stream
BACKUP_SESSION_STREAMING_CONNECTED	INFO	String	Backup streaming started
BACKUP_SESSION_STREAMING_DISCONNECTED	INFO	String	Backup streaming ended
STREAM_FINISH	INFO	String	Channel unavailable Contact the customer center for details
AVG_BPS_LOW_WARN	INFO	String	Bitrate coming into the channel unstable Need to check streaming status
ERROR	ERROR	String	Channel streaming abnormal Check streaming status
STREAM_BLOCKED_ON_LIVE	ERROR	String	Channel disabled due to unstable channel streaming Channel is disabled for about 5 minutes
STREAM_BLOCKED_AT_START	ERROR	String	Channel disabled due to specific streaming option Channel usage blocked for about 30 minutes
STREAM_BLOCKED_UNDEFINED	ERROR	String	Channel disabled for unknown reasons. Channel is disabled for about 1 hour
STREAM_UNBLOCK	ERROR	String	Channel suspension cleared Available after restreaming
STREAM_UNBLOCK_BY_MANUALLY	ERROR	String	Channel block cleared
STREAM_UNBLOCK_FAILED	ERROR	String	Failed to clear channel block Contact the customer center
STREAM_BLOCKED_BY_MANUALLY	ERROR	String	Channel disabled
PROCESSING_FAIL	ERROR	String	Failed to create recording file for unknown reason
FAIL_RELAY	ERROR	String	Failed to stream for unknown reason
FAIL_ONAIR	ERROR	String	Failed to start recording for unknown reason
FAIL_STOP	ERROR	String	Failed to end recording for unknown reason
FAIL_FINISH	ERROR	String	Failed to stop stream for unknown reason
FAIL_FORCE	ERROR	String	Failed to stop stream for unknown reason
FAIL_RELEASE	ERROR	String	Failed to stop stream for unknown reason
PP_STOP_FAIL	ERROR	String	Unknown error occurred
NO_SPS_PPS	ERROR	String	Unusual video packet inflow
AUDIO_INFO_CHANGED	ERROR	String	Unusual inflow of re-stream channel audio packets
VIDEO_INFO_CHANGED	ERROR	String	Unusual inflow of re-stream channel video packets
FAILED_TO_PARSE_METADATA	ERROR	String	Unable to read video and audio packets coming into re-stream channel
UNSUPPORTED_MEDIA_CODEC	ERROR	String	Streaming codec not supported
INCORRECT_KEY_INTERVAL	ERROR	String	Incoming keyframe interval greater than 4 seconds
UNSUPPORTED_AUDIO_FRAMERATE	ERROR	String	Incoming audio FrameRate unusually high
UNSUPPORTED_VIDEO_FRAMERATE	ERROR	String	Incoming video FrameRate unusually high
UNSUPPORTED_AUDIO_BITRATE	ERROR	String	Incoming audio Bitrate unusually high
UNSUPPORTED_VIDEO_BITRATE	ERROR	String	Incoming video Bitrate unusually high
UNSUPPORTED_VIDEO_RESOLUTION	ERROR	String	Incoming video Bitrate unusually high
TOO_MANY_DISCONNECTION	ERROR	String	Connection very unstable
RACE_DISCONNECTION	ERROR	String	Frequent connection crashes due to duplicate transmissions in the last 30 seconds
PREROLL_FAILED	ERROR	String	Unusual packet inflow for either audio/video for 5 minutes
LARGE_READ_TIME_GAP	ERROR	String	No video or audio packet inflow for about 10 seconds after connection
UNEXPECTED_CONNECTION_ERROR	ERROR	String	Streaming terminated for unknown reason
LARGE_AUDIO_VIDEO_TIME_GAP	ERROR	String	Unusual timestamp differences between incoming audio/video packets
FAILED_TO_ALLOC_MEM	ERROR	String	Streaming terminated for unknown reason
AUDIO_OVERRUN	ERROR	String	Unusual difference between incoming and transcoding audio packet timestamps
VIDEO_OVERRUN	ERROR	String	Unusual difference between incoming and transcoding video packet timestamps
UNKNOWN	ERROR	String	UNKNOWN

Examples

Request example

GET /api/v2/channels/ls-20200313162828-G60tN/events
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

Response example

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
    "content" : [
        {
            "logLevel" : "INFO",
            "eventCode" : "PUBLISH_START",
            "description" : "You have started publishing channel ls-20200313162828-G60tN.",
            "timestamp" : 1585572599000
        },
        {
            "logLevel" : "INFO",
            "eventCode" : "PUBLISH_END",
            "description" : "ls-20200313162828-G60tN channel publishing has ended.",
            "timestamp" : 1585559611000
        },
        {
            "logLevel" : "INFO",
            "eventCode" : "ONAIR_END",
            "description" : "ls-20200313162828-G60tN Channel recording has ended.",
            "timestamp":1585559598000
        }
    ],
    "total" : 3
}

Was this article helpful?

What's Next

Get channel publish event list

Table of contents

Request
Response
Examples