Ncloud Chat 개요

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

Ncloud Chat은 실시간 채팅 및 메시지 시스템, 여러 사용자가 참여하는 채팅 채널을 구현할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Ncloud Chat 서비스에서는 구독, 사용자, 채널, 메시지, 친구, 토큰 기능에 대한 API를 RESTful 형태로 제공합니다.

API 권한 설정

Ncloud Chat API를 사용하려면 접근 권한을 설정해야 합니다.
Ncloud Chat 대시보드의 설정 > 보안에서 API 액세스 권한 설정을 Read/Write 상태로 저장해 주십시오.

참고

Ncloud Chat 대시보드는 네이버 클라우드 플랫폼 콘솔에서 Services > Business Applications > Ncloud Chat 메뉴로 진입한 후, 프로젝트 목록에서 관리 페이지 URL을 클릭하여 접근할 수 있습니다.

Ncloud Chat 공통 설정

Ncloud Chat API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://dashboard-api.ncloudchat.naverncp.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-api-key Required Ncloud Chat용 API 키
  • Ncloud Chat 대시보드의 설정 > 일반에서 API 키 확인
    • [API 키 재생성] 버튼 클릭하면 키가 재발급되며, 이전 키 사용 불가
x-project-id Required Ncloud Chat 프로젝트 아이디
  • Ncloud Chat 대시보드의 설정 > 일반에서 프로젝트 ID 확인

응답

공통 응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

Error
Error는 API 호출 실패 정보를 정의합니다. Error에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
status Integer - 응답 코드
message String - 오류 메시지

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
- 1 - 응답 성공
- -1 -
  • 등록되지 않은 API 키 입력
  • 접근 권한 없음
    		•
    - -2 - 대시보드의 API 키와 헤더에 입력한 API 키 상이
    - -3 - 삭제된 API 키
    - -4 - 대시보드에서 미사용 처리된 API 키
    - -5 - 만료된 API 키
    - -6 - 프로젝트 아이디가 존재하지 않음
    참고

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

    호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

    {
    "status": -1,
    "message": "projectId is empty"
}

    Ncloud Chat API

    Ncloud Chat에서 제공하는 API에 대한 설명은 다음과 같습니다.

    토큰

    토큰 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    토큰 발급 인증 토큰 발급

    사용자

    사용자 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    사용자 등록 사용자 등록
    사용자 목록 조회 사용자 목록 조회
    사용자 조회 사용자 상세 정보 조회
    사용자 정보 수정 사용자 정보 수정
    사용자 탈퇴 사용자 탈퇴
    푸시 알림 설정 사용자에게 푸시 알림 설정
    푸시 알림 설정 조회 사용자의 푸시 알림 설정 내역 조회
    푸시 알림 설정 해제 사용자의 푸시 알림 설정 해제

    친구

    친구 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    친구 요청 친구 요청 전송
    친구 일괄 요청 다수의 친구 요청 일괄 전송
    친구 거절 친구 요청 거절
    친구 수락 친구 요청 수락

    메시지

    메시지 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    메시지 전송 메시지 전송
    메시지 목록 조회 메시지 목록 조회
    메시지 조회 메시지 상세 정보 조회
    메시지 삭제 메시지 삭제

    채널

    채널 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    채널 생성 채널 생성
    채널 목록 조회 채널 목록 조회
    채널 조회 채널 상세 정보 조회
    채널 수정 채널 정보 수정
    채널 삭제 채널 삭제

    구독

    구독 관련 API에 대한 설명은 다음과 같습니다.

    API 설명
    채널 구독 목록 조회 채널 구독 내역 목록 조회

    Ncloud Chat 연관 리소스

    Ncloud Chat API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.