채널 수정

Prev Next

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

채널 정보를 수정합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String Optional 채널 이름
uniqueId String Optional 채널 고유 아이디
  • 고유 식별 용도로 사용자가 입력하는 아이디
type String Optional 채널 유형
  • PUBLIC | PRIVATE
    • PUBLIC: 공개
    • PRIVATE: 비공개
translation Boolean Optional 자동 번역 여부
  • true | false
    • true: 번역
    • false: 번역 안 함
members Array Optional 구독 가능한 사용자 아이디 목록
  • type이 PRIVATE인 경우, 입력
disabled Boolean Optional 비활성화 여부
  • true | false
    • true: 비활성화
    • false: 활성화
mutes Boolean Optional 음소거 여부
  • true | false
    • true: 음소거
    • false: 음소거 안 함
push Boolean Optional 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
limit Integer Optional 최대 참여 인원 수
  • 0: 무제한
linkUrl String Optional 채널 링크 URL
  • 일정 조건을 만족하는 URL 입력
imageUrl String Optional 채널 이미지 URL
  • 일정 조건을 만족하는 URL 입력
참고

채널 링크 URL(linkUrl)과 채널 이미지 URL(imageUrl)은 다음 조건을 만족해야 합니다.

  • 도메인만 입력할 수 없습니다.
  • 대상 서버가 상태 코드 200(OK)을 반환해야 합니다.
  • 응답에 Header와 Content-Type이 포함되어야 합니다.
  • 채널 이미지 URL 예시: https://www.gitbook.com/cdn-cgi/image/width=40,dpr=2,height=40,fit=contain,format=auto/https://2238982255-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/spaces%2F-LNAM8Kjj1jpQoidHTej%2Favatar-1592576907682.png?generation=1592576908144636&alt=media

요청 예시

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

curl --location --request PUT 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/channels/469645e9-****-****-****-d0a58e38d312' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "mychanneltest",
    "uniqueId": "ncpchanneltest789",
    "translation": false,
    "mutes": false,
    "push": true,
    "limit": 40
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "channel": {
        "id": "469645e9-****-****-****-d0a58e38d312",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "name": "mychanneltest",
        "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
        "user": {
            "id": "TWVtYmVyc**************************************jZDRmZWY0NmU=",
            "name": "Admin",
            "profile": ""
        },
        "unique_id": "ncpchanneltest789",
        "type": "PRIVATE",
        "translation": false,
        "members": [
            "user_5",
            "NCP007",
            "NCP001TestAOS",
            "osoriz123"
        ],
        "disabled": false,
        "mutes": false,
        "push": true,
        "limit": 40,
        "link_url": "{Link URL}",
        "image_url": "{Image URL}",
        "created_at": "2025-07-23T16:02:00+09:00",
        "updated_at": "2025-07-23T16:52:10+09:00"
    },
    "status": 1
}