채팅방 부가기능

이 문서에서는 채팅 기능 외에 채팅방에서 사용할 수 있는 부가 기능에 대해 설명합니다.

유저 신고

사용자는 채팅 메시지를 신고할 수 있으며, 신고된 내용은 CMS에서 관리자가 확인 후 차단, 강제 퇴장 등 필요한 조치를 할 수 있습니다.

await fetch("https://www.vchatcloud.com/api/openapi/insertChatBanUser", {
  method: "POST",
  body: new URLSearchParams({
    room_id: 'YOUR_ROOM_ID', // 채팅방 ID
    buser_nick: 'BAN_USER_NICKNAME', // 신고할 유저의 닉네임
    buser_msg: 'BAN_USER_SEND_MESSAGE', // 신고할 메시지
    buser_chat_id: 'BAN_USER_CLIENT_KEY', // 신고할 유저의 CLIENT KEY
  }),
});

채팅방 초대 메일 전송

초대할 이메일 주소를 입력하면 해당 주소로 채팅방 접속 링크가 포함된 초대 메일이 전송됩니다. 해당 기능을 채팅방에 구현하면 사용자가 참여하기를 원하는 다른 사용자에게 초대 메일을 전송할 수 있으며, 채팅방에 참여하도록 할 수 있습니다.

await fetch("https://www.vchatcloud.com/api/openapi/inviteWebRtc", {
  method: "POST",
  body: new URLSearchParams({
    room_id: 'YOUR_ROOM_ID', // 채팅방 ID
    to_email: 'EMAIL_ADDRESS', // 초대 메일을 발송할 이메일 주소
    url: 'CHAT_ROOM_URL', // 채팅방 주소
  }),
});

채팅방 접속 유저 목록 조회

채팅방에 접속한 유저의 닉네임, 등급 등 정보를 조회할 수 있으며, 이를 통해 접속중인 유저의 프로필, 닉네임 목록을 표기하는 등 다양한 작업에 활용할 수 있습니다.

channel.getAllUserList(function (err, list) {
  if (err) {
    console.error("유저 목록을 조회하던 중 오류가 발생했습니다.", err);
    return;
  }

  console.log(list);
});

• list 정보 (해당 데이터의 배열임)

  필드	타입	설명
  roomId	String	채팅방의 고유 키 (Channel Key)
  clientKey	String	사용자의 클라이언트의 고유 식별자
  nickName	String	사용자의 닉네임
  grade	String	사용자의 등급
  userInfo	Object	사용자 부가정보

채팅방 공유 파일 목록 조회

채팅방에 공유된 파일 목록을 조회할 수 있습니다. 해당 기능을 이용해서 샘플의 파일 서랍기능 등을 구현할 수 있습니다.

const roomId = "YOUR_ROOM_ID";
await fetch(`https://www.vchatcloud.com/api/openapi/getFileList?roomId=${roomId}`, {
  method: 'POST'
});

• 응답 데이터

키	타입	설명
result_cd	Number	요청 처리 결과 코드입니다. 1은 성공을 의미합니다.
result_msg	String	요청 처리 결과 메시지입니다. 성공 시 빈 문자열("")이 반환될 수 있습니다.
data	Object	파일 목록 데이터가 담겨있는 객체입니다. 상세 내용은 아래 data 객체 설명을 참고하세요.

• data 객체

키	타입	설명
size	Number	조회된 전체 파일의 개수입니다.
list	Array	파일 정보 객체들을 담고 있는 배열입니다.

• list 배열 내 파일 정보 객체

키	타입	설명
fileNm	String	서버에 저장된 고유한 파일명입니다.
fileSize	Number	파일의 실제 크기입니다. (단위: byte)
expire	String	파일 만료일입니다. (형식: yyyy.MM.dd)
fileKey	String	파일을 식별하는 고유 키입니다. 파일 다운로드 등 다른 API 호출 시 사용될 수 있습니다.
fileSizeText	String	사용자가 읽기 편한 형태의 파일 크기 문자열입니다.
fileExt	String	파일 확장자입니다.
originFileNm	String	사용자가 업로드했을 때의 원본 파일명입니다.