Callback Endpointの登録

Classic/VPC環境で利用できます。

全チャンネルのイベントを受信できるデフォルトコールバックエンドポイントを登録します。

コールバック送信データ

コールバックエンドポイントを登録すると、イベントが発生するたびに指定されたエンドポイント URLにデータが送信されます。データの送信には HTTP POSTメソッドを使用します。送信データの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	Required	イベント識別子
`logLevel`	String	Required	ログレベル
`channelId`	String	Required	チャンネル ID
`event`	String	Required	イベントコード
`timestamp`	Integer	Required	イベント発生日時(ミリ秒) Unix Timestamp形式

送信データのサンプルコードは次の通りです。

{
    "id": 1234,
    "logLevel": "INFO",
    "channelId": "ls-20200327******-aBCD3",
    "event": "STREAM_UPDATE",
    "timestamp": 1599218791425
}

参考

コールバック送信動作は次のように決定されます。

チャンネル別コールバックエンドポイントを登録した場合: そのチャンネルのコールバックエンドポイントに送信
デフォルトコールバックエンドポイントだけ登録した場合: デオフォルトコールバックエンドポイントに送信
デフォルトとチャンネル別コールバックエンドポイントをいずれも登録していない場合: 送信しない

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v2/events/callbackEndpoint

リクエストヘッダ

Live Station APIで共通して使用されるヘッダの詳細は、Live Stationのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`callbackUrl`	String	Required	コールバックエンドポイント URL

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/events/callbackEndpoint' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
    "callbackUrl": "https://www.callback-endpoint.com"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content`	Object	-	レスポンス結果
`content.callbackUrl`	String	-	コールバックエンドポイント URL
`content.updateTime`	Integer	-	更新日時(ミリ秒) Unix Timestamp形式

レスポンスステータスコード

Live Station APIで共通して使用されるレスポンスステータスコードの詳細は、Live Stationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": {
        "callbackUrl": "https://www.callback-endpoint.com",
        "updateTime": 1755750398046
    }
}