...
After the VidyoClient/VidyoConnector is successfully initialized, global VC object will become available.
Media escalation feature
CTLive offers a basic media escalation feature. A customer with an ongoing chat can request an engagement of the video channel by creating a video conference. The CTLive SDK library offers a notification and response API allowing you to perform a request-response-engagement flow on the video channel.
Request API (on customer side)
| Code Block |
|---|
LIVECHAT.requestVideoUpgrade(<chat_id>); |
Request Event notification (on agent side)
Register a callback on contact object for the “requestVideoUpgrade” event.
| Code Block | ||
|---|---|---|
| ||
contact.on("requestVideoUpgrade",
function (event) {
// the Agent can accept/refuse the video media escalation
}
); |
Response API (on agent side)
| Code Block | ||
|---|---|---|
| ||
LIVECHATSDK.LIVECHAT.responseVideoUpgrade(<chat_id>, <boolean>);
// if true the Agent integration generate a new token
// and create a new Video Connector Object as shown in the following section |
Response Event notification (on customer side)
| Code Block |
|---|
contact.on("responseVideoUpgrade",
function (event) {
console.log("On [responseVideoUpgrade] event", event.response);
// The CTLive Widget generate a new Token and create a new Video Connector Object
}
) |
Connect to a Video Room or create a new one
...
Name | Type | Description |
|---|---|---|
onJoined | function | Callback that is triggered when another participant joins a conference. |
onLeft | function | Callback that is triggered when an existing participant leaves a conference. |
onDynamicChanged | function | Callback that is triggered when the order of participants has changed, based on their importance according to active speech detection. |
onLoudestChanged | function | Callback that is triggered when a new participant becomes the loudest, based on active speech detection. |
Detect a Media escalation
CTLive offers a basic media escalation feature. A customer with an ongoing chat can request an engagement of the video channel by creating a video conference. The CTLive SDK library offers a notification and response API allowing you to perform a request-response-engagement flow on the video channel.
Request API (on customer side)
| Code Block |
|---|
LIVECHAT.requestVideoUpgrade(<chat_id>); |
Request Event notification (on agent side)
Register a callback on contact object for the “requestVideoUpgrade” event.
| Code Block | ||
|---|---|---|
| ||
contact.on("requestVideoUpgrade",
function (event) {
// the Agent can accept/refuse the video media escalation
}
); |
Response API (on agent side)
| Code Block | ||
|---|---|---|
| ||
LIVECHATSDK.LIVECHAT.responseVideoUpgrade(<chat_id>, <boolean>);
// if true the Agent integration generate a new token
// and create a new Video Connector Object as shown in the previous section |
Response Event notification (on customer side)
...
Documentation
Vidyo Developer Center: https://developer.vidyo.io/#/documentation
...