채널 조회

Prev Next

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

채널의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /v1/api/channels/{channelId}

요청 헤더

Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
channelId String Required 채널 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/ef14cd79-****-****-****-3efc52465f08' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
id String - 채널 아이디
project_id String - 프로젝트 아이디
name String - 채널 이름
user_id String - 채널 생성자 아이디
user Object - 생성자 정보
user.id String - 채널 생성자 아이디
user.name String - 생성자 이름
user.profile String - 생성자 프로필 이미지
unique_id String - 채널 고유 아이디
  • 고유 식별 용도로 사용자가 입력하는 아이디
type String - 채널 유형
  • PUBLIC | PRIVATE
    • PUBLIC: 공개
    • PRIVATE: 비공개
translation Boolean - 자동 번역 여부
  • true | false
    • true: 번역
    • false: 번역 안 함
members Array - 구독 가능한 사용자 아이디 목록
  • type이 PRIVATE인 경우, 유효 값 표시
disabled Boolean - 비활성화 여부
  • true | false
    • true: 비활성화
    • false: 활성화
mutes Boolean - 음소거 여부
  • true | false
    • true: 음소거
    • false: 음소거 안 함
push Boolean - 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
limit Integer - 최대 참여 인원 수
  • 0: 무제한
link_url String - 채널 링크 URL
image_url Array - 채널 이미지 URL
created_at String - 채널 생성 일시
  • ISO 8601 형식
updated_at String - 정보 수정 일시
  • ISO 8601 형식

응답 상태 코드

Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "id": "ef14cd79-****-****-****-3efc52465f08",
    "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
    "name": "channel_apitester",
    "user_id": "39c8de0f-****-****-****-6a1a875df59f",
    "user": {
        "id": "TWVtYmVycz****************************************ODc1ZGY1OWY=",
        "name": "apitester",
        "profile": ""
    },
    "unique_id": "apitester123",
    "type": "PUBLIC",
    "translation": true,
    "members": [],
    "disabled": false,
    "mutes": false,
    "push": true,
    "limit": 0,
    "link_url": null,
    "image_url": null,
    "created_at": "2025-07-23T13:52:52+09:00",
    "updated_at": "2025-07-23T14:03:20+09:00"
}