목록/정보

그룹 채널 목록 조회

그룹 채널 목록을 페이징 조회 할 수 있습니다. 조회 정렬 기준은 생성일 내림차순입니다.

다음 페이지가 있을 경우 응답 데이터에 'next' 정보가 전달됩니다. 응답에서 받은 'next' 값을 사용하여 다음 목록을 조회 할 수 있습니다. 다음 페이지 조회 시, 'next' 값만 전달하면 됩니다.

Parameters

속성	설명	유형	기본값	필수여부
limit	페이지 당 목록 수, 허용 범위 5 ~ 30	Number	15	X
show_members	채널 매니저 정보 포함 여부	Boolean	false	X
show_managers	채널 참가자 정보 포함 여부	Boolean	false	X
show_read_receipt	채널 읽기 영수증 정보 포함 여부	Boolean	false	X
show_delivery_receipt	채널 배달 영수증 정보 포함 여부	Boolean	false	X
show_unread	사용자별 읽지않은 메시지 수 정보 포함 여부	Boolean	false	X
show_last_message	채널 마지막 메시지 정보 포함 여부	Boolean	false	X
name	검색할 채널 이름(URL 인코딩 권장)	String	없음	X
include_members	참가자 검색 목록. 콤마(,)로 구분된 사용자 ID 문자열(공백 허용 안함)로 참가자들이 포함된 채널을 검색합니다. AND 조건입니다. (URL 인코딩 권장)	String	없음	X
next	다음 페이지 키	String	없음	X

try {
  const params: GroupChannelFindParams {
    limit?: number;
    show_members?: boolean;
    show_managers?: boolean;
    show_read_receipt?: boolean;
    show_delivery_receipt?: boolean;
    show_unread?: boolean;
    show_last_message?: boolean;
    name?: string;
    include_members?: string;
    next?: string;
  }
  const results = await gitpleLiveChatClient.groupChannel.getChannelList(params);
  //  results: {
  //    channels: [...],
  //    next: 'Next Page Key',
  //  }
} catch (error) {
  // handle error
}

참가한 그룹 채널 목록 조회

사용자가 참가한 그룹 채널 목록을 페이징 조회 할 수 있습니다. 조회 정렬 기준은 생성일 내림차순입니다.

다음 페이지가 있을 경우 응답 데이터에 'next' 정보가 전달됩니다. 응답에서 받은 'next' 값을 사용하여 다음 목록을 조회 할 수 있습니다. 다음 페이지 조회 시, 'next' 값만 전달하면 됩니다.

Parameters

속성	설명	유형	기본값	필수여부
limit	페이지 당 목록 수, 허용 범위 5 ~ 30	Number	15	X
show_members	채널 매니저 정보 포함 여부	Boolean	false	X
show_managers	채널 참가자 정보 포함 여부	Boolean	false	X
show_read_receipt	채널 읽기 영수증 정보 포함 여부	Boolean	false	X
show_delivery_receipt	채널 배달 영수증 정보 포함 여부	Boolean	false	X
show_unread	사용자별 읽지않은 메시지 수 정보 포함 여부	Boolean	false	X
show_last_message	채널 마지막 메시지 정보 포함 여부	Boolean	false	X
name	검색할 채널 이름(URL 인코딩 권장)	String	없음	X
include_members	참가자 검색 목록. 콤마(,)로 구분된 사용자 ID 문자열(공백 허용 안함)로 참가자들이 포함된 채널을 검색합니다. AND 조건입니다. (URL 인코딩 권장)	String	없음	X
next	다음 페이지 키	String	없음	X

try {
  const params: GroupChannelFindParams {
    limit?: number;
    show_members?: boolean;
    show_managers?: boolean;
    show_read_receipt?: boolean;
    show_delivery_receipt?: boolean;
    show_unread?: boolean;
    show_last_message?: boolean;
    name?: string;
    include_members?: string;
    next?: string;
  }
  const results = await gitpleLiveChatClient.groupChannel.getJoinedChannelList(params);
  //  results: {
  //    channels: [...],
  //    next: 'Next Page Key',
  //  }
} catch (error) {
  // handle error
}

그룹 채널 정보

caution

사용자가 참가한 채널만 조회할 수 있습니다.

Parameters

속성	설명	유형	기본값	필수여부
channel_id	채널 아이디	String	없음	O

try {
  const channel_id = 'Group Channel ID';
  const channel = await gitpleLiveChatClient.groupChannel.getChannel(channel_id);
} catch (error) {
  // handle error
}