OPEN API

Game Chat의 몇몇 기능을 규정 된 API로 호출할 수 있는 기능입니다.

대시보드에서 발급한 허용된 API Key를 사용해야 호출이 가능합니다.

API Key 확인

API Key는 대시보드 > 설정 > 프로젝트 설정 > API Key 에서 생성할 수 있습니다.

재발급 버튼을 누르면 키가 재발급 되며, 이전 키는 사용할 수 없으니 주의하세요.

Open API 사용하기

Base URL

https://dashboard-api.gamechat.naverncp.com/v1/api/project/{projectId}

- {projectId}부분에는 Game Chat의 project id를 적용

공통 Error code

Open API 요청시 발생하는 공통 에러코드입니다.

채널 생성 API

채널을 생성합니다.

Request

  • Method : POST

  • URI : /channel

POST
url : https://dashboard-api.gamechat.naverncp.com/v1/api/project/{projectId}/channel
Header : 'x-api-key: {API Key}'
Header : 'content-type: application/json'
data: '{
    "name":"#All"
}'

Response

{
    "status": 1,
    "result": "1a51af0d-f464-4440-8ad6-ce69e0bdaba8"
}

Error code

채널 수정 API

채널의 정보를 수정합니다.

Request

  • Method : PUT

  • URI : /channel/{channelId}

PUT
url : https://dashboard-api.gamechat.naverncp.com/v1/api/project/{projectId}/channel/{channelId}
Header : 'x-api-key: {API Key}'
data: '{
    "name":"#GUILD"
}'

Response

성공

{
    "status": 1,
    "message": "success"
}

채널 삭제 API

채널을 삭제합니다.

Request

  • Method : DELETE

  • URI : /channel/{channelId}

DELETE
url : https://dashboard-api.gamechat.naverncp.com/v1/api/project/{projectId}/channel/{channelId}
Header : 'x-api-key: {API Key}'

Response

성공

{
    "status": 1,
    "message": "success"
}
PreviousUnity SDK

Last updated