# 참고사항
이 문서는 vchatCloud API 요청시 참고해야할 사항을 다룹니다.
# webRTC
# webRTC 옵션
webRTC형 채팅방 생성(수정)시 오디오, 비디오, 화면공유 옵션을 설정할 수 있으며,
이 옵션들은 2진수 아홉 자릿수지만, 관련 API를 호출할 때에 10진수로 변환하여 요청해야 합니다.
좌측부터 세 자릿수씩 화면공유, 카메라, 오디오 기능 설정 값을 나타내며, 기능에 따른 2진수는 다음과 같습니다.
| 2진수 | 기능 | 설명 |
|---|---|---|
| XXX XXX 000 | audio disable | 오디오 사용 안함 |
| XXX XXX 001 | audio enable | 오디오 사용 |
| XXX XXX 011 | audio on | 채팅방 입장시 오디오 켜기 default: on |
| XXX 000 XXX | video disable | 비디오 사용 안함 |
| XXX 001 XXX | video enable | 비디오 사용 |
| XXX 011 XXX | video on | 채팅방 입장시 비디오 켜기 default: on |
| 000 XXX XXX | share disable | 화면공유 사용 안함 |
| 001 XXX XXX | share enable | 화면공유 사용 |
# webRTC 옵션 예시
- 오디오·비디오를 사용하는 채팅방 생성, 채팅방 입장시 비디오 ON을 기본 값으로 설정하고자 하는 경우
올바른 예시: 000011001(2) 👉 webrtc 에 25를 입력한다.
| 기능 | 화면공유 | 비디오 | 오디오 |
|---|---|---|---|
| 2진수 | 000 | 011 | 001 |
| 설명 | 사용안함 default: x | 사용 default: on | 사용 default: off |
아래의 경우에는 webrtc형 채팅방이 생성(수정)되지 않습니다.
000001010(2) / 10👉 오디오를 사용하지 않는 채팅방에서 오디오 켜기를 기본으로 설정한 경우000010001(2) / 17👉 비디오를 사용하지 않는 채팅방에서 비디오 켜기를 기본으로 설정한 경우 등
# webRTC 옵션 관련 API
# sendDate
# sendDate 전달시 주의사항
sendCustom API는 즉시전송과 예약전송으로 API 요청이 나뉩니다.
즉시 전송하고 싶은 경우, sendDate 필드를 빈값으로 두고 API를 요청하면 커스텀 메시지가 바로 전송됩니다.
예약 전송의 경우, API 요청시 sendDate 값을 request body로 전송해야 합니다.
| 즉시전송 | 예약전송 |
|---|---|
sendDate를 공란으로 비워둔다. | sendDate에 값을 입력한다. |
sendDate 형식: YYYYMMDDHH24MISS 연(4)+월(2)+일(2)+시(2,24시간표기)+분(2)+초(2)
# sendDate 예시
- 2022-05-26 05:17:00 PM에 커스텀 메시지를 예약 전송하고자 하는 경우
올바른 예시: 20220526171700
아래의 경우에는 메시지가 전송되지 않습니다.
220526171700👉 년도를 2자리만 입력한 경우20220026171700👉 달력 범위 밖의 값을 입력한 경우202205261717👉 초를 입력하지 않은 경우 등