プレイヤー名のチェック

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

プレイヤー名の有効性と重複チェックを行います。

リクエスト

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

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

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

curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/checkName?name=player001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

チェックの結果、使用可能な名前の場合

チェックの結果、使用可能な名前の場合のレスポンスのサンプルコードは次の通りです。

{
    "code": "200",
    "message": "ok"
}

チェックの結果、使用できない名前の場合

チェックの結果、使用できない名前の場合のレスポンスのサンプルコードは次の通りです。

{
    "error": {
        "errorCode": "4802",
        "message": "This player already exists."
    }
}