Search channel event lists
    • PDF

    Search channel event lists

    • PDF

    Article Summary

    This is an API to search the list of channel events.

    Requests

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

    Request headers

    Header nameRequirement statusDescription
    x-ncp-apigw-timestampYESIt indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid
    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)

    Responses

    Field nameTypeDescriptionRemarks
    logLevelStringINFO, ERROR
    eventCodeString
    descriptionString
    timestampInteger

    Event code details

    eventCodelogLevelTypeDescription
    STREAM_RESERVEINFOStringCreated channel
    STREAM_UPDATEINFOStringUpdated channel settings
    PUBLISH_ENDINFOStringTerminated channel transmission
    PUBLISH_StartINFOStringStarted channel transmission
    THUMBNAIL_CREATEINFOStringCreated channel thumbnail
    SIMULCAST_STATUS_CHANGEINFOStringUpdated target platform status
    ONAIR_StartINFOStringStart recording channel
    ONAIR_ENDINFOStringClose recording channel
    PUBLISH_OVER_THRESHOLDINFOStringTransmitted when the bit rate flowing into the channel exceeds the threshold
    RTMP_MAIN_STREAM_ENABLEDINFOStringMain stream transmission activated
    RTMP_BACKUP_STREAM_ENABLEDINFOStringMain transmission switched to backup stream transmission
    BACKUP_SESSION_STREAMING_CONNECTEDINFOStringBackup stream transmission started
    BACKUP_SESSION_STREAMING_DISCONNECTEDINFOStringBackup stream transmission ended
    STREAM_FINISHINFOStringUnavailable channel
    For more details, contact the customer center
    AVG_BPS_LOW_WARNINFOStringUnstable bit rate flowing into the channel
    Required to check transmission status
    ERRORERRORStringAbnormal channel transmission
    Check transmission status
    STREAM_BLOCKED_ON_LIVEERRORStringSuspended channel use due to unstable channel transmission
    Suspended channel usage for about 5 minutes
    STREAM_BLOCKED_AT_StartERRORStringSuspended channel usage due to certain transmission options
    Blocked channel usage for about 30 minutes
    STREAM_BLOCKED_UNDEFINEDERRORStringYour channel has been suspended for an unknown reason. Suspended channel usage for about 1 hour
    STREAM_UNBLOCKERRORStringCanceled channel suspension
    Can use after retransmission.
    STREAM_UNBLOCK_BY_MANUALLYINFOStringCanceled suspension of channel use
    STREAM_UNBLOCK_FAILEDERRORStringFailed to cancel channel suspension
    Contact customer center
    STREAM_BLOCKED_BY_MANUALLYERRORStringSuspended channel use
    PROCESSING_FAILERRORStringFailed to create recording file for unknown reason
    FAIL_RELAYERRORStringFailed to transmit for unknown reason
    FAIL_ONAIRERRORStringUnable to start recording for unknown reason
    FAIL_STOPERRORStringUnable to close recording for unknown reason
    FAIL_FINISHERRORStringFailed to suspend transmission for unknown reason
    FAIL_FORCEERRORStringFailed to suspend transmission for unknown reason
    FAIL_RELEASEERRORStringFailed to suspend transmission for unknown reason
    PP_STOP_FAILERRORStringAn unknown error has occurred
    NO_SPS_PPSERRORStringAbnormal video packet inflow
    AUDIO_INFO_CHANGEDERRORStringRe-Stream channel Audio packet inflow is not normal
    VIDEO_INFO_CHANGEDERRORStringRe-Stream channel Video packet inflow is not normal
    FAILED_TO_PARSE_METADATAERRORStringUnable to read video and audio packets flowed into the Re-Stream channel
    UNSUPPORTED_MEDIA_CODECERRORStringThe codec being transmitted is not supported
    INCORRECT_KEY_INTERVALERRORStringIncoming Keyframe interval greater than 4 seconds
    UNSUPPORTED_AUDIO_FRAMERATEERRORStringIncoming Audio FrameRate is abnormally high
    UNSUPPORTED_VIDEO_FRAMERATEERRORStringIncoming Video FrameRate is abnormally high
    UNSUPPORTED_AUDIO_BITRATEERRORStringIncoming Audio Bitrate is abnormally high
    UNSUPPORTED_VIDEO_BITRATEERRORStringIncoming Video Bitrate is abnormally high
    UNSUPPORTED_VIDEO_RESOLUTIONERRORStringIncoming Video Bitrate is abnormally high
    TOO_MANY_DISCONNECTIONERRORStringConnection is very unstable
    RACE_DISCONNECTIONERRORStringFrequent connection conflicts due to duplicate transmission within the last 30 seconds
    PREROLL_FAILEDERRORStringOne of the audio/video packets has not been in normal condition for 5 minutes
    LARGE_READ_TIME_GAPERRORStringThere have been no incoming video or audio packets for about 10 seconds after the connection
    UNEXPECTED_CONNECTION_ERRORERRORStringThe transmission has been ended due to unknown reasons
    LARGE_AUDIO_VIDEO_TIME_GAPERRORStringThe difference in timestamps between the incoming audio/video packets is abnormal
    FAILED_TO_ALLOC_MEMERRORStringThe transmission has been ended due to unknown reasons
    AUDIO_OVERRUNERRORStringThe difference in timestamp between the incoming audio/transcoding audio packets is abnormal
    VIDEO_OVERRUNERRORStringThe difference in timestamps between the incoming video/transcoding video packets is abnormal
    UNKNOWNERRORStringUNKNOWN

    Examples

    Request examples

    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 examples

    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?

    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.