콘텐츠로 이동

기본 정보

Chat API 사용에 앞서, 공통적으로 알아야 하는 기본 정보를 설명합니다.

사전 준비

Chat API를 사용하려면 아래의 항목이 필요합니다.

  • Hive Certification Key(Hive 인증키): API 호출을 위한 인증 토큰
    • Hive 콘솔 > 앱센터 > 프로젝트 관리 > 게임 상세 > 기본 정보 에서 확인 가능
  • Game Index(게임 인덱스): Hive 콘솔 > 앱센터 > 프로젝트 관리 에서 생성한 게임의 인덱스
Warning
  • Hive 인증키는 민감한 보안 정보이므로 절대 외부에 노출해서는 안됩니다. 보안을 위해 소스 코드에 직접 포함하는 것을 삼가고, 클라이언트 환경의 기능 구현이 필요할 경우 Hive SDK를 이용해 주십시오.
  • 모든 Chat API는 서버 간(Server-to-Server) 통신 방식으로 동작합니다. 게임 클라이언트에서 직접 API를 호출하는 경우, 인증 토큰 유출 및 예상치 못한 문제가 발생할 수 있으므로 각별히 유의하여 사용해야 합니다.

공통 헤더

필드명 설명 타입 필수 여부
Authorization API 호출을 위한 인증 토큰 (Bearer) string Y
Content-Type 요청 데이터의 타입 (application/json) string Y

응답 코드

  • 공통 코드
HTTP 상태 코드 코드 메시지 설명
200 0 Success. 성공
400 100 Bad request. 잘못된 요청
401 101 Invalid token. 유효하지 않은 토큰
403 102 Forbidden. 권한 없음
404 103 Not found. 찾을 수 없음
405 104 Method not allowed. 허용되지 않은 메서드
500 105 Internal server error. 내부 서버 오류
503 108 Server is busy. please request later. 서버 과부화
  • 에러 코드
HTTP 상태 코드 코드 메시지 설명
400 200 Duplicate channel ID. 중복된 채널 ID
400 201 Channel not found or deleted. 채널을 찾을 수 없음 또는 삭제됨
400 202 Channel is full. 채널 참여 인원을 초과하여 채널 입장 불가
400 203 Invalid channel password. 유효하지 않은 채널 비밀번호
400 204 Message size exceeded. The maximum size is 200. 메시지 크기 초과 (최대 200자)
400 300 User not in session. 사용자가 세션에 없음 (소켓 서버에 접속하지 않은 상태)
400 301 User not in the channel. 사용자가 채널에 없음
400 302 User is already in the channel. 사용자가 이미 채널에 있음
400 303 User already blocked. 사용자가 이미 차단됨
400 304 Block list is full. The maximum size is 100. 차단 목록이 가득 참 (최대 100명)
400 305 User not in block list. 사용자가 차단 목록에 없음
400 306 User is blocked. 사용자가 차단됨
400 307 The maximum number of channels the user can enter has been exceeded. 해당 사용자의 입장 가능한 채널 수 초과
403 308 User is not the owner of the channel. 사용자가 채널 소유자가 아님
400 400 Custom message size exceeded. The maximum size is 8,000 Byte. 커스텀 메시지 크기 초과 (최대 8,000바이트)