Open API 사용하기

개요

VChatCloud는 단순 채팅기능뿐만 아니라 여러 부가기능을 Open API형식으로 제공하고 있습니다. 이러한 API들은 SDK내부에 VChatCloudApi클래스에 포함하고 있으며 함수를 호출해 사용하면 됩니다.

채팅방 정보 조회 메서드

채팅방의 정보를 조회하는 메서드입니다.

ChatRoomModel roomInfo = await VChatCloudApi.getRoomInfo(roomId: "YOUR_CHANNEL_KEY");

• 파라미터 값

  값	식별자	설명
  roomId	String	CMS에서 생성한 채팅방의 ChannelKey

• 결과 값

  값	식별자	설명
  roomInfo	ChatRoomModel	방 정보

채팅방 좋아요 개수 조회 메서드

채팅방의 좋아요 누적 개수를 조회하는 메서드입니다.

int likeCount = await VChatCloudApi.getLike(roomId: "YOUR_CHANNEL_KEY");

• 파라미터 값

  값	식별자	설명
  roomId	String	CMS에서 생성한 채팅방의 ChannelKey

• 결과 값

  값	식별자	설명
  likeCount	int	채팅방 누적 좋아요 개수

채팅방 좋아요 개수 추가 메서드

채팅방에 좋아요 개수를 추가하는 메서드입니다.

int likeCount = await VChatCloudApi.like(roomId: "YOUR_CHANNEL_KEY");

• 파라미터 값

  값	식별자	설명
  roomId	String	CMS에서 생성한 채팅방의 ChannelKey

• 결과 값

  값	식별자	설명
  likeCount	int	채팅방 누적 좋아요 개수

채팅방에 업로드 된 파일 목록 조회 메서드

채팅방에 업로드 된 파일 목록을 조회하는 메서드입니다.

List<FileModel> fileList = await VChatCloudApi.getFileList(roomId: "YOUR_CHANNEL_KEY");

• 파라미터 값

  값	식별자	설명
  roomId	String	CMS에서 생성한 채팅방의 ChannelKey

• 결과 값

  값	식별자	설명
  fileList	List<FileModel>	업로드 된 파일 목록 배열

채팅방에 업로드 된 파일 다운로드 메서드

채팅방에 업로드 된 파일의 데이터를 가져와 지정한 경로에 저장하는 메서드입니다.

String roomId = "YOUR_CHANNEL_KEY";
List<FileModel> fileList = await VChatCloudApi.getFileList(roomId: roomId);
File result = await VChatCloudApi.download(
  file: fileList.first,
  downloadPath: "/",
);

• 파라미터 값

  값	식별자	설명
  file	FileModel	파일 정보
  downloadPath	String	파일을 저장할 경로

• 결과 값

  값	식별자	설명
  result	File	저장 된 파일 객체

OpenGraph 정보 요청 메서드

원하는 URL의 OpenGraph정보를 요청하는 메서드입니다.

var url = "https://vchatcloud.com"; // 원하는 주소를 입력하세요.
OpenGraphModel openGraphInfo = await VChatCloudApi.openGraph(requestUrl: url);

• 파라미터 값

  값	식별자	설명
  requestUrl	String	OpenGraph 정보를 조회 할 URL

• 결과 값

  값	식별자	설명
  openGraphInfo	OpenGraphModel	OpenGraph 정보

구글 번역 메서드

원하는 글자를 구글 번역 API를 이용해 번역해주는 메서드입니다. 해당 기능을 사용하기 위해서는 먼저 구글에서 API KEY를 발급 받습니다. CMS에서 채팅방 설정에서 구글 번역을 사용으로 설정하신 후 Google API KEY값에 구글에서 발급받은 API KEY를 입력하신 후 수정버튼을 클릭하여 저장하신 후 이용하실 수 있습니다.

Google API KEY를 발급받는 과정에 대한 설명은 번역 사용하기에 자세한 설명이 있습니다.

번역할 수 있는 언어 목록 및 코드

target에 사용할 수 있는 언어코드는 구글의 언어지원 항목을 참고하세요.

GoogleTranslationModel translated = await VChatCloudApi.googleTranslation(
  text: "message",
  target: "en",
  roomId: "YOUR_CHANNEL_KEY",
);

• 파라미터 값

  값	식별자	설명
  text	String	번역을 하고자 하는 텍스트
  target	String	번역을 하고자 하는 언어
  roomId	String	CMS에서 생성한 채팅방의 ChannelKey

• 결과 값

  값	식별자	설명
  translated	GoogleTranslationModel	번역된 메시지 내용