# Note

This document covers the vchatCloud API requirements for reference.

# webRTC

# webRTC option

When creating (modifying) a webRTC type chat room, you can set audio, video, and screen sharing options.
These options are nine binary digits, but when calling the relevant API, you must convert it to decimal and request it.

webrtc

Display screen sharing, camera, and audio function settings in three digits from the left. The binary number of the function is as follows.

binary function
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

# Example of webRTC options

  • If you want to use audio and video to generate a chat room and set the video ON to the default value when entering the chat room

Correct example: 000011001(2)👉Enter 25 in webrtc.

function screen sharing video audio
binary 000 011 001
description Don't use
default: x
use
default: on
use
default: off

The Webrtc chat room will not be created (modified) in the following situations:

  • 000001010(2) / 10 👉 When audio on is set to default in a chat room that does not use audio,
  • 000010001(2) / 17 👉 When video on is set to default in a chat room that does not use video,

# sendDate

# Note for SendDate

The sendCustom API separates API requests by sending immediately and sending reservations.
If you want to send immediately, you can send a custom message immediately by placing the sendDate field as empty and requesting an API.
If you want to send reservations, if you request an API, please send the sendDate value to the request body.

immediately reservations
sendDate empty sendDate not empty

sendDate Type: YYYYMMDDHH24MISS

# example of sendDate

  • 2022-05-26 05:17:00 PM If you want to send a custom message by reservation

Correct example: 20220526171700

Messages are not sent in the following situations:

  • 220526171700 👉 If you enter only two digits of the year
  • 20220026171700 👉 If you enter a value outside the calendar range
  • 202205261717 👉 If you don't enter seconds
Copyright © 2020 | E7Works.Inc & JOYTUNE Corp.