# API 목록
vchatCloud API는 기능에 따라 채팅방 관리 API, 사용자 관리 API, 채팅 API로 구분됩니다.
모든 API는 호출할 때 API KEY와 발급받은 토큰 값을 전송해야 합니다.
- 채팅방 관리: 채팅방 목록, 상세 정보를 조회하고 채팅방을 개설, 수정, 폐쇄할 수 있게 하는 채팅방 관련 API입니다.
- 사용자 관리: 채팅방 사용자를 조회하며 사용자의 이용을 제한하고 해제 할 수 있게 하는 사용자 관련 API입니다.
- 채팅: 공지사항, 귓속말, 예약 메시지 전송을 할 수 있게 하는 채팅 관련 API입니다.
TIP
✔️ API_KEY, roomId, clientKey 확인, X-AUTH-TOKEN 발급은 준비사항의 각 항목을 참조하세요.
# 채팅방 관리(chatRoom)
다음은 채팅방 관리 API에서 사용하는 주요 요청 URL과 메서드, 응답 형식입니다.
| 요청 URL | 메서드 | 응답 형식 | 설명 |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/rooms | GET/POST | JSON | 채팅방 목록 정보, 채팅방 생성을 요청합니다. |
| https://vchatcloud.com/openapi/v1/rooms/{roomId} | GET/POST/DEL | JSON | 채팅방 상세 정보, 채팅방 수정, 삭제를 요청합니다. |
# 사용자 관리(chatUser)
다음은 사용자 관리 API에서 사용하는 주요 요청 URL과 메서드, 응답 형식입니다.
| 요청 URL | 메서드 | 응답 형식 | 설명 |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/users/{roomId} | GET | JSON | 채팅방 사용자 목록과 상세 정보를 요청합니다. |
| https://vchatcloud.com/openapi/v1/exiles/{roomId} | GET | JSON | 추방된 사용자 목록과 상세 정보를 요청합니다. |
| https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey} | POST/PUT | JSON | 사용자 추방, 추방 해제를 요청합니다. |
| https://vchatcloud.com/openapi/v1/mute/{roomId} | GET | JSON | 글쓰기 제한된 사용자 목록과 상세 정보를 요청합니다. |
| https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey} | POST/PUT | JSON | 사용자 글쓰기 제한, 제한 해제를 요청합니다. |
# 채팅(chat)
다음은 채팅 API에서 사용하는 주요 요청 URL과 메서드, 응답 형식입니다.
| 요청 URL | 메서드 | 응답 형식 | 설명 |
|---|---|---|---|
| https://vchatcloud.com/openapi/v1/notice/{roomId} | POST | JSON | 공지사항 전송을 요청합니다. |
| https://vchatcloud.com/openapi/v1/custom/{roomId} | POST | JSON | 커스텀 메시지 전송을 요청합니다. |
| https://vchatcloud.com/openapi/v1/custom/{roomId}/{scheduleId} | DEL | JSON | 커스텀 메시지 전송 취소를 요청합니다. |
| https://vchatcloud.com/openapi/v1/whisper/{roomId}/{clientKey} | POST | JSON | 귓속말 전송을 요청합니다. |