Audio & Video Chat
You need the Manage Settings permission to manage Audio & Video Chat.
Audio & Video Chat
- Audio & Video Chat Manage
GET livechat/audioVideoChatConfig
POST livechat/audioVideoChatConfig:disable
POST livechat/audioVideoChatConfig:enable
PUT livechat/audioVideoChatConfig
Model
Audio & Video Chat JSON Format
Audio & Video Chat is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
isEnabled |
bool | Whether this audio & video chat is enabled or not. |
isAutomaticallyRecordingAudioVideoChatsEnabled |
bool | Whether the automatically recording of this audio & video chat is enabled or not. |
recordingServerUrl |
string | The URL of recording server. |
Endpoint
Get a single Audio & Video Chat
GET livechat/audioVideoChatConfig
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/audioVideoChatConfig \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Disable the Audio & Video Chat
POST livechat/audioVideoChatConfig:disable
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/audioVideoChatConfig:disable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Enable the Audio & Video Chat
POST livechat/audioVideoChatConfig:enable
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/audioVideoChatConfig:enable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the Audio & Video Chat
PUT livechat/audioVideoChatConfig
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether this audio & video chat is enabled or not. |
isAutomaticallyRecordingAudioVideoChatsEnabled |
bool | body | no | Whether the automatically recording of this audio & video chat is enabled or not. |
recordingServerUrl |
string | body | yes | The URL of recording server. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/audioVideoChatConfig \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isEnabled":false,"isAutomaticallyRecordingAudioVideoChatsEnabled":false,"recordingServerUrl":"http://google.com"}'
Response:
HTTP/1.1 200 OK