Check player name

Available in Classic and VPC

Check validity and duplication of a player name.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Video Player Enhancement APIs, see Video Player Enhancement request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the HTTP status codes common to all Video Player Enhancement APIs, see Common Video Player Enhancement response status codes.

Response example

The response example is as follows:

If check result is available name

The following is a sample response if the check results in an available name.

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

If check result is unavailable name

The following is a sample response if the check results in an unavailable name.

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