MENU
      Get channel event list

        Get channel event list


        Article summary

        This is an API to get the channel event list.

        Request

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

        Request headers

        Header nameRequiredDescription
        x-ncp-apigw-timestampYESThis 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-keyYESValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        x-ncp-region_codeYESRegion code (KR)

        Response

        Field nameTypeDescriptionRemarks
        logLevelStringINFO, ERROR
        eventCodeString
        descriptionString
        timestampInteger

        Event code details

        eventCodelogLevelTypeDescription
        STREAM_RESERVEINFOStringChannel created
        STREAM_UPDATEINFOStringChannel settings updated
        PUBLISH_ENDINFOStringChannel streaming ended
        PUBLISH_STARTINFOStringChannel streaming started
        THUMBNAIL_CREATEINFOStringChannel thumbnail created
        SIMULCAST_STATUS_CHANGEINFOStringTarget platform status updated
        ONAIR_STARTINFOStringChannel recording started
        ONAIR_ENDINFOStringChannel recording ended
        PUBLISH_OVER_THRESHOLDINFOStringBitrate coming into the channel exceeded the threshold and sent out
        RTMP_MAIN_STREAM_ENABLEDINFOStringMain streaming enabled
        RTMP_BACKUP_STREAM_ENABLEDINFOStringMain stream switched to backup stream
        BACKUP_SESSION_STREAMING_CONNECTEDINFOStringBackup streaming started
        BACKUP_SESSION_STREAMING_DISCONNECTEDINFOStringBackup streaming ended
        STREAM_FINISHINFOStringChannel unavailable
        Contact the customer center for details
        AVG_BPS_LOW_WARNINFOStringBitrate coming into the channel unstable
        Need to check streaming status
        ERRORERRORStringChannel streaming abnormal
        Check streaming status
        STREAM_BLOCKED_ON_LIVEERRORStringChannel disabled due to unstable channel streaming
        Channel is disabled for about 5 minutes
        STREAM_BLOCKED_AT_STARTERRORStringChannel disabled due to specific streaming option
        Channel usage blocked for about 30 minutes
        STREAM_BLOCKED_UNDEFINEDERRORStringChannel disabled for unknown reasons. Channel is disabled for about 1 hour
        STREAM_UNBLOCKERRORStringChannel suspension cleared
        Available after restreaming
        STREAM_UNBLOCK_BY_MANUALLYERRORStringChannel block cleared
        STREAM_UNBLOCK_FAILEDERRORStringFailed to clear channel block
        Contact the customer center
        STREAM_BLOCKED_BY_MANUALLYERRORStringChannel disabled
        PROCESSING_FAILERRORStringFailed to create recording file for unknown reason
        FAIL_RELAYERRORStringFailed to stream for unknown reason
        FAIL_ONAIRERRORStringFailed to start recording for unknown reason
        FAIL_STOPERRORStringFailed to end recording for unknown reason
        FAIL_FINISHERRORStringFailed to stop stream for unknown reason
        FAIL_FORCEERRORStringFailed to stop stream for unknown reason
        FAIL_RELEASEERRORStringFailed to stop stream for unknown reason
        PP_STOP_FAILERRORStringUnknown error occurred
        NO_SPS_PPSERRORStringUnusual video packet inflow
        AUDIO_INFO_CHANGEDERRORStringUnusual inflow of re-stream channel audio packets
        VIDEO_INFO_CHANGEDERRORStringUnusual inflow of re-stream channel video packets
        FAILED_TO_PARSE_METADATAERRORStringUnable to read video and audio packets coming into re-stream channel
        UNSUPPORTED_MEDIA_CODECERRORStringStreaming codec not supported
        INCORRECT_KEY_INTERVALERRORStringIncoming keyframe interval greater than 4 seconds
        UNSUPPORTED_AUDIO_FRAMERATEERRORStringIncoming audio FrameRate unusually high
        UNSUPPORTED_VIDEO_FRAMERATEERRORStringIncoming video FrameRate unusually high
        UNSUPPORTED_AUDIO_BITRATEERRORStringIncoming audio Bitrate unusually high
        UNSUPPORTED_VIDEO_BITRATEERRORStringIncoming video Bitrate unusually high
        UNSUPPORTED_VIDEO_RESOLUTIONERRORStringIncoming video Bitrate unusually high
        TOO_MANY_DISCONNECTIONERRORStringConnection very unstable
        RACE_DISCONNECTIONERRORStringFrequent connection crashes due to duplicate transmissions in the last 30 seconds
        PREROLL_FAILEDERRORStringUnusual packet inflow for either audio/video for 5 minutes
        LARGE_READ_TIME_GAPERRORStringNo video or audio packet inflow for about 10 seconds after connection
        UNEXPECTED_CONNECTION_ERRORERRORStringStreaming terminated for unknown reason
        LARGE_AUDIO_VIDEO_TIME_GAPERRORStringUnusual timestamp differences between incoming audio/video packets
        FAILED_TO_ALLOC_MEMERRORStringStreaming terminated for unknown reason
        AUDIO_OVERRUNERRORStringUnusual difference between incoming and transcoding audio packet timestamps
        VIDEO_OVERRUNERRORStringUnusual difference between incoming and transcoding video packet timestamps
        UNKNOWNERRORStringUNKNOWN

        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
        HTTP

        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
        }
        HTTP

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.