videoengager-js-sdk

v1.3.1

Published

2 years ago

OpenAPI client for videoengager-js-sdk

0High
0Medium
0Low

videoengager

axios typescript openapi-client openapi-generator videoengager-js-sdk

VideoEngager Javascript SDK

Version

VideoEngager Javascript SDK - Javascript SDK for VideoEngager API

API version: 1.0.0
Package version: 1.3.1

The VideoEngager Javascript SDK implements the client-side libraries used by applications using VideoEngager API services. This SDK is distributed via:

Installation

Install the package from npm:

npm install videoengager-js-sdk@latest --save

Browser

The package also works in the browser environment. The client is exposed as SmartVideoSdk global variable when using from https://unpkg.com/[email protected]/dist/browser/main.js file.

<script src="https://unpkg.com/[email protected]/dist/browser/main.js"></script>
<script>
  var smartVideoSdk = SmartVideoSdk
</script>

You can also load VideoEngager Javascript SDK packages as script modules in browsers that support native ES modules.

<script type="module">
  import * as smartVideoSdk from 'https://unpkg.com/[email protected]/dist/esm/index.js';
</script>

Getting Started

Please follow the installation instruction and execute the following JS code:

var smartVideoSDK = require('videoengager-js-sdk');

const configuration = {
    pak: '134124-5134123-52341-213',
    basePath: 'https://prod.videoengager.com',
    externalId: 'Home',
    email: '[email protected]',
  };

smartVideoSDK.initializeSmartVideoClient(configuration);
// .. do something with the client

initialization of the client generate token and store it to be used in all the requests. instead of generating accessToken using PAK and email, you can use your own accessToken.

var smartVideoSDK = require('videoengager-js-sdk');

const configuration = {
    accessToken: 'yourAccessToken'
  };
smartVideoSDK.initializeSmartVideoClient(configuration)

some of the requests are not required to be authenticated. to use the client without authentication, you can use the following code:

var smartVideoSDK = require('videoengager-js-sdk');
const configuration = {
    basePath: 'https://prod.videoengager.com'
  };

smartVideoSDK.initializeSmartVideoClient(configuration);
// .. do something with the client

Client API Reference

authentication

authenticatePartner

Authenticate Using Partner Access Key

This API will generate a token for the partner to use in the SDK

Requires Authentication: false

Parameters

pak (required) - TYPE: string - Partner API Key
externalId (required) - TYPE: string - External ID
email (required) - TYPE: string - partner email


const response = await smartVideoSDK.authentication.authenticatePartner({
    pak,
    externalId,
    email
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<AuthenticatePartner200Response>

Example Response:

{
  "token_expiration" : 0,
  "token" : "eyJhbGciOiJIUzI1NXssInR5cCI6IkpXVCJ9.eyJfaWQiOiI2M2UxODhlNFEcwTNjNTY4ODAzYTljZTYiLCJwYWsiOiJERVYyIiwiaWF0IjoxNjc1NzkwODI5LCJleHAiOjE2NzgzODI4Mjl9.wIz7qVBUaWMxfH-IDCSkSWWsmKtc2QYPQoHpLUtLlAM"
}

callbacks

createCallback

Create New Genesys Callback

Notes. URL is required, transferID is needed if you want to be able to deactive it later, pin will not be applied if brokerage settings doesn't allow it, if code is not provided, code automatically will be generated.

Requires Authentication: true

Parameters

requestBody (required) - TYPE: [{ [key: string]: string; }](#{ [key: string]: string; }) -
tenantId (required) - TYPE: string - Tennant ID


const response = await smartVideoSDK.callbacks.createCallback({
    requestBody,
    tenantId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbackObject>

Example Response:

{
  "genesys" : {
    "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
    "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
    "conversation" : {
      "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
    }
  },
  "videoengager" : {
    "date" : 1676303962674,
    "code" : "k8DOH4",
    "subject" : "bla bla",
    "created" : "2023-02-13T15:59:22.684Z",
    "autoAnswer" : true,
    "active" : true,
    "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
    "duration" : 60,
    "phone" : "+971585194108",
    "name" : "Mamoun H",
    "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
    "email" : "[email protected]",
    "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
    "customAttributes" : {
      "additionalProp1" : "value1",
      "additionalProp3" : "value2"
    }
  },
  "emailSent" : true,
  "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
}

deleteCallbackByConversationId

remove callback by conversation ID

used to deactive remove callback by conversation ID

Requires Authentication: true

Parameters

tenantId (required) - TYPE: string - Tennant ID
conversationId (required) - TYPE: string - Conversation ID


const response = await smartVideoSDK.callbacks.deleteCallbackByConversationId({
    tenantId,
    conversationId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbackObject>

Example Response:

{
  "genesys" : {
    "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
    "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
    "conversation" : {
      "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
    }
  },
  "videoengager" : {
    "date" : 1676303962674,
    "code" : "k8DOH4",
    "subject" : "bla bla",
    "created" : "2023-02-13T15:59:22.684Z",
    "autoAnswer" : true,
    "active" : true,
    "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
    "duration" : 60,
    "phone" : "+971585194108",
    "name" : "Mamoun H",
    "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
    "email" : "[email protected]",
    "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
    "customAttributes" : {
      "additionalProp1" : "value1",
      "additionalProp3" : "value2"
    }
  },
  "emailSent" : true,
  "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
}

getCallbackByConversationId

Get Single Callback

used to retrieve callback by conversation id

Requires Authentication: true

Parameters

tenantId (required) - TYPE: string - Tennant ID
conversationId (required) - TYPE: string - Conversation ID


const response = await smartVideoSDK.callbacks.getCallbackByConversationId({
    tenantId,
    conversationId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbackObject>

Example Response:

{
  "genesys" : {
    "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
    "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
    "conversation" : {
      "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
    }
  },
  "videoengager" : {
    "date" : 1676303962674,
    "code" : "k8DOH4",
    "subject" : "bla bla",
    "created" : "2023-02-13T15:59:22.684Z",
    "autoAnswer" : true,
    "active" : true,
    "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
    "duration" : 60,
    "phone" : "+971585194108",
    "name" : "Mamoun H",
    "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
    "email" : "[email protected]",
    "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
    "customAttributes" : {
      "additionalProp1" : "value1",
      "additionalProp3" : "value2"
    }
  },
  "emailSent" : true,
  "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
}

getTennantAvailability

Get Availablity of tennant for tennant

should return Object of dates strings with true or false

Requires Authentication: false

Parameters

tenantId (required) - TYPE: string - Tennant ID
numberOfDays (required) - TYPE: number - number of days to return
start (required) - TYPE: string - start date (Number, Date ISO String, or Date)


const response = await smartVideoSDK.callbacks.getTennantAvailability({
    tenantId,
    numberOfDays,
    start
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<[{ [key: string]: number; }](#{ [key: string]: number; })>

Example Response:

{
  "2023-02-13T15:59:22.684Z" : 1,
  "2023-02-13T16:59:22.684Z" : 1,
  "2023-02-13T17:59:22.684Z" : 0
}

getTennantCalendar

Get Calendar configuration of tennant

Calendar configuration of tennant can be set in Settings page

Requires Authentication: false

Parameters

tenantId (required) - TYPE: string - Tennant ID


const response = await smartVideoSDK.callbacks.getTennantCalendar({
    tenantId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<string>

listCallbacks

List Callbacks for specific tennant.

Returns a list of callbacks for specific tenant and period with Server Side Pagination, Sorting and Filtering.

Requires Authentication: true

Parameters

tenantId (required) - TYPE: string - Tenant ID
from (required) - TYPE: string - start of the period
to (required) - TYPE: string - End of the period
preferedAgent - TYPE: string - filter result by preferred agent
orderBy - TYPE: ['duration' | 'created' | 'date' | 'canceled'](#'duration' | 'created' | 'date' | 'canceled') - Order by (default is date)
asc - TYPE: [1 | -1](#1 | -1) - Order by ascending or descending
pageSize - TYPE: number - Page size
page - TYPE: number - Page number
searchBy - TYPE: string - * Search by specific field (will search in all fields if not specified) <br /> * Allowed values: visitor.name, visitor.email, conversationId, visitor.phone, "customAttributes.*" * (where * is the name of the custom attribute)
searchString - TYPE: string - Search string
active - TYPE: boolean - Filter by active or inactive
queueId - TYPE: string - Filter by queue


const response = await smartVideoSDK.callbacks.listCallbacks({
    tenantId,
    from,
    to,
    preferedAgent,
    orderBy,
    asc,
    pageSize,
    page,
    searchBy,
    searchString,
    active,
    queueId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbacksList>

Example Response:

{
  "queueId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
  "data" : [ {
    "genesys" : {
      "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
      "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
      "conversation" : {
        "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
      }
    },
    "videoengager" : {
      "date" : 1676303962674,
      "code" : "k8DOH4",
      "subject" : "bla bla",
      "created" : "2023-02-13T15:59:22.684Z",
      "autoAnswer" : true,
      "active" : true,
      "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
      "duration" : 60,
      "phone" : "+971585194108",
      "name" : "Mamoun H",
      "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
      "email" : "[email protected]",
      "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
      "customAttributes" : {
        "additionalProp1" : "value1",
        "additionalProp3" : "value2"
      }
    },
    "emailSent" : true,
    "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
  }, {
    "genesys" : {
      "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
      "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
      "conversation" : {
        "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
      }
    },
    "videoengager" : {
      "date" : 1676303962674,
      "code" : "k8DOH4",
      "subject" : "bla bla",
      "created" : "2023-02-13T15:59:22.684Z",
      "autoAnswer" : true,
      "active" : true,
      "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
      "duration" : 60,
      "phone" : "+971585194108",
      "name" : "Mamoun H",
      "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
      "email" : "[email protected]",
      "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
      "customAttributes" : {
        "additionalProp1" : "value1",
        "additionalProp3" : "value2"
      }
    },
    "emailSent" : true,
    "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
  }, {
    "genesys" : {
      "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
      "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
      "conversation" : {
        "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
      }
    },
    "videoengager" : {
      "date" : 1676303962674,
      "code" : "k8DOH4",
      "subject" : "bla bla",
      "created" : "2023-02-13T15:59:22.684Z",
      "autoAnswer" : true,
      "active" : true,
      "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
      "duration" : 60,
      "phone" : "+971585194108",
      "name" : "Mamoun H",
      "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
      "email" : "[email protected]",
      "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
      "customAttributes" : {
        "additionalProp1" : "value1",
        "additionalProp3" : "value2"
      }
    },
    "emailSent" : true,
    "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
  }, {
    "genesys" : {
      "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
      "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
      "conversation" : {
        "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
      }
    },
    "videoengager" : {
      "date" : 1676303962674,
      "code" : "k8DOH4",
      "subject" : "bla bla",
      "created" : "2023-02-13T15:59:22.684Z",
      "autoAnswer" : true,
      "active" : true,
      "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
      "duration" : 60,
      "phone" : "+971585194108",
      "name" : "Mamoun H",
      "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
      "email" : "[email protected]",
      "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
      "customAttributes" : {
        "additionalProp1" : "value1",
        "additionalProp3" : "value2"
      }
    },
    "emailSent" : true,
    "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
  }, {
    "genesys" : {
      "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
      "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
      "conversation" : {
        "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
      }
    },
    "videoengager" : {
      "date" : 1676303962674,
      "code" : "k8DOH4",
      "subject" : "bla bla",
      "created" : "2023-02-13T15:59:22.684Z",
      "autoAnswer" : true,
      "active" : true,
      "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
      "duration" : 60,
      "phone" : "+971585194108",
      "name" : "Mamoun H",
      "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
      "email" : "[email protected]",
      "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
      "customAttributes" : {
        "additionalProp1" : "value1",
        "additionalProp3" : "value2"
      }
    },
    "emailSent" : true,
    "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
  } ],
  "preferedAgent" : "82212b25-0976-2048-ed3e-6cb1fac47977",
  "count" : 52,
  "searchBy" : "customAttributes.customID",
  "pageSize" : 100,
  "orderBy" : "date",
  "active" : true,
  "asc" : 1,
  "searchString" : "asdasd",
  "from" : "2023-02-13T15:59:22.684Z",
  "to" : "2023-02-13T15:59:22.684Z",
  "page" : 1
}

removeCallbackByScheduleId

remove callback by schedule ID

used to deactive remove callback by schedule ID

Requires Authentication: true

Parameters

tenantId (required) - TYPE: string - Tennant ID
scheduleId (required) - TYPE: string - Schedule ID


const response = await smartVideoSDK.callbacks.removeCallbackByScheduleId({
    tenantId,
    scheduleId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbackObject>

Example Response:

{
  "genesys" : {
    "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
    "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
    "conversation" : {
      "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
    }
  },
  "videoengager" : {
    "date" : 1676303962674,
    "code" : "k8DOH4",
    "subject" : "bla bla",
    "created" : "2023-02-13T15:59:22.684Z",
    "autoAnswer" : true,
    "active" : true,
    "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
    "duration" : 60,
    "phone" : "+971585194108",
    "name" : "Mamoun H",
    "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
    "email" : "[email protected]",
    "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
    "customAttributes" : {
      "additionalProp1" : "value1",
      "additionalProp3" : "value2"
    }
  },
  "emailSent" : true,
  "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
}

updateCallbackByConversationId

Update Single Callback

used to update callback schedule time by conversation id

Requires Authentication: true

Parameters

callbackUpdateRequest (required) - TYPE: CallbackUpdateRequest - callback object
tenantId (required) - TYPE: string - Tennant ID
conversationId (required) - TYPE: string - Conversation ID


const response = await smartVideoSDK.callbacks.updateCallbackByConversationId({
    callbackUpdateRequest,
    tenantId,
    conversationId
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<CallbackObject>

Example Response:

{
  "genesys" : {
    "queueId" : "a1731678-13f6-4ab0-ac6d-f82813b7abee",
    "scriptId" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a",
    "conversation" : {
      "id" : "950be2a3-65b7-461e-8ba2-f8fb62c2d95a"
    }
  },
  "videoengager" : {
    "date" : 1676303962674,
    "code" : "k8DOH4",
    "subject" : "bla bla",
    "created" : "2023-02-13T15:59:22.684Z",
    "autoAnswer" : true,
    "active" : true,
    "meetingUrl" : "https://dev.videoengager.com/ve/k8DOH4",
    "duration" : 60,
    "phone" : "+971585194108",
    "name" : "Mamoun H",
    "agentUrl" : "https://dev.videoengager.com/ve/iqTF6W",
    "email" : "[email protected]",
    "scheduleId" : "82212b25-0976-2048-ed3e-6cb1fac47977",
    "customAttributes" : {
      "additionalProp1" : "value1",
      "additionalProp3" : "value2"
    }
  },
  "emailSent" : true,
  "icsCalendarData" : "BEGIN:VCALENDAR VERSION:2.0 CALSCALE:GREGORIAN PRODID:adamgibbons/ics METHOD:REQUEST X-PUBLISHED-TTL:PT1H BEGIN:VEVENT UID:82212b25-0976-2048-ed3e-6cb1fac47977 SUMMARY:Video Meeting DTSTAMP:20230213T155700Z DTSTART:20230213T155900Z SEQUENCE:1 DESCRIPTION:Start your video meeting by opening URL in your browser URL:https://dev.videoengager.com/ve/k8DOH4 LOCATION:https://dev.videoengager.com/ve/k8DOH4 STATUS:CONFIRMED CREATED:20230213T155900Z ATTENDEE;RSVP=TRUE;ROLE=OPT-PARTICIPANT;PARTSTAT=ACCEPTED;CN=Mamoun unde fined:mailto:[email protected] DURATION:PT60M END:VEVENT END:VCALENDAR"
}

settingsPublic

getPublicSettingsByTennantId

Get Public Settings by Tennant ID

Returns public settings by tennant ID

Requires Authentication: false

Parameters

tenantID (required) - TYPE: string - Tennant ID


const response = await smartVideoSDK.settingsPublic.getPublicSettingsByTennantId({
    tenantID
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<SettingsPublicResponse>

Example Response:

{
  "backgroundUrl" : "img/bg-ds.jpg",
  "lastName" : "NO_C",
  "showEmail" : true,
  "enableReplaceVideoTracks" : true,
  "fileTransfer" : {
    "disableAgent" : true,
    "disableVisitor" : true,
    "enable" : true
  },
  "waitingMessage" : "test123",
  "tooltipAvatar" : true,
  "shortUrl" : "t",
  "branding" : {
    "disablevideourlgeneration" : true,
    "redirectUrl" : "https://www.videoengager.com/",
    "genesysActive" : true,
    "URL" : "http://www.videoengager.com/",
    "hideCustomerRecordingIndicator" : true,
    "visitorScreenShareControl" : true,
    "visitorShowPrecall" : true,
    "allowEditInviteUrl" : true,
    "agentCameraControl" : true,
    "hideAgentRecordingIndicator" : true,
    "inviteUrl" : "http://videoengager/",
    "logo" : "/static/widgets/img/in-logo-small.png",
    "text" : "VideoEngager",
    "activateCustomShortUrl" : true,
    "buttons" : {
      "wd-v-snapshot" : true,
      "wd-v-annotation" : true,
      "wd-v-video" : true,
      "wd-v-blur" : true
    },
    "allowAllsidebarItems" : true,
    "isPipActive" : true,
    "customShortUrl" : {
      "publicKey" : "PUBLIC_KEY",
      "env" : "test",
      "enabled" : true,
      "url" : "https://videoengager.com/static/demos/customURL"
    },
    "invalidUrl" : "https://www.videoengager.com/",
    "domainUrl" : "https://videoengager.com/",
    "visitorCameraControl" : true,
    "talkdeskActive" : true,
    "zoomButton" : true,
    "agentScreenShareControl" : true,
    "visitorBackgroundUrl" : "https://domain.com/bg.png"
  },
  "startThreeWayCall" : true,
  "widgetSize" : {
    "width" : 874,
    "height" : 451
  },
  "enablePin" : true,
  "locale" : "en-us",
  "organizationId" : "SOME_ID",
  "pin_shorturl" : "vidme.in",
  "agentCameraOn" : true,
  "defaultGroup" : "floor",
  "frontMessage" : "Get Live Help",
  "constTooltip" : true,
  "tennantId" : "test_tenant",
  "company" : "The Brokerage",
  "id" : "63dcdf380b16aa5b308c40ea",
  "callWrapUp" : true,
  "agentReplyTimeOut" : 0,
  "email" : "[email protected]",
  "bandwidth" : {
    "warningMessage" : "Poor Connection",
    "threshold" : 100
  },
  "isPopup" : true,
  "contactEmail" : "SOME_EMAIL",
  "enablePoorConnectionDectect" : true,
  "dropAnimation" : true,
  "privateAccess" : true,
  "torch" : true,
  "enableGenesysKpiFeature" : true,
  "disableAnonymousThreeWayCall" : true,
  "randomTooltip" : true,
  "enablePrecallWorkflow" : true,
  "startWidget" : true,
  "recordingInNewTab" : true,
  "noCallRedirectTimeoutSec" : 0,
  "hideStatus" : true,
  "cameraOn" : true,
  "firstName" : "NO_C",
  "disableAgentStatus" : true,
  "chatOriented" : true,
  "enablePrivate" : true,
  "showTooltipVideo" : true,
  "viewWidget" : "4"
}

shortURLAuthenticated

createShortURL

Create new shortURL

Notes. URL is required, transferID is needed if you want to be able to deactive it later, pin will not be applied if brokerage settings doesn't allow it, if code is not provided, code automatically will be generated. - if pin is passed, pinShortURL will be generated, if code is passed, veShortURL will be generated.

Requires Authentication: true

Parameters

createShortURLRequest (required) - TYPE: CreateShortURLRequest -
tenantID (required) - TYPE: string - Tennant ID


const response = await smartVideoSDK.shortURLAuthenticated.createShortURL({
    createShortURLRequest,
    tenantID
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<ShortUrlCreateResponse>

Example Response:

{
  "code" : "asd5s",
  "pin" : 7987,
  "tennantId" : "tenantId",
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "veShortUrl" : "https://domain.com/ve/shortUrl",
  "transferId" : "00000000-0000-0000-0000-000000000000",
  "pinShortUrl" : "https://domain.com/pin/1985",
  "userId" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}

deactivateShortURL

deactivate ShortURL

used to deactive all shortURLs that belong to transfer ID

Requires Authentication: true

Parameters

tenantID (required) - TYPE: string - Tennant ID
transferID (required) - TYPE: string - Transfer ID


const response = await smartVideoSDK.shortURLAuthenticated.deactivateShortURL({
    tenantID,
    transferID
});

console.log(response.data); // response

Return Type

getShortURLsForTennant

List Short Urls for specific tennant.

Returns the Short Urls for the current authorized user for a given time period. The result is paginated.

Requires Authentication: true

Parameters

tenantID (required) - TYPE: string - Tennant ID
from - TYPE: string - Start date of the period to get the ShortUrls for. The format is ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ)
to - TYPE: string - End date of the period to get the ShortUrls for. The format is ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ)
expand - TYPE: boolean - Expand the result to include the full details of the ShortUrl (Creator details)
page - TYPE: number - Page number
pageSize - TYPE: number - Page size
searchString - TYPE: string - Search string
searchBy - TYPE: SearchByShortURL - Search by specific field (empty value search all fields)
orderBy - TYPE: OrderByShortURL - Order by specific field
asc - TYPE: ASCShortURL - Ascending or descending order


const response = await smartVideoSDK.shortURLAuthenticated.getShortURLsForTennant({
    tenantID,
    from,
    to,
    expand,
    page,
    pageSize,
    searchString,
    searchBy,
    orderBy,
    asc
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<ShortUrlListResponse>

Example Response:

{
  "searchString" : "someURL",
  "data" : [ {
    "code" : "asd5s",
    "invalidUrl" : "https://domain.com/invalidUrl",
    "active" : true,
    "veShortUrl" : "https://domain.com/ve/shortUrl",
    "transferId" : "00000000-0000-0000-0000-000000000000",
    "pinShortUrl" : "https://domain.com/pin/1985",
    "userId" : "63dcdf380b16aa5b308e40d5",
    "url" : "https://domain.com/longUrl",
    "expand" : {
      "firstName" : "First Name",
      "lastName" : "Last Name",
      "agentId" : "63dcdf380b16aa5b308e40d5",
      "isAgent" : true,
      "isBrokerage" : true,
      "brokerageId" : "63dcdf380b16aa5b308e40d5"
    },
    "pin" : 7987,
    "tennantId" : "tenantId",
    "expire" : "2023-02-13T15:59:22.684Z",
    "_id" : "63dcdf380b16aa5b308e40d5"
  }, {
    "code" : "asd5s",
    "invalidUrl" : "https://domain.com/invalidUrl",
    "active" : true,
    "veShortUrl" : "https://domain.com/ve/shortUrl",
    "transferId" : "00000000-0000-0000-0000-000000000000",
    "pinShortUrl" : "https://domain.com/pin/1985",
    "userId" : "63dcdf380b16aa5b308e40d5",
    "url" : "https://domain.com/longUrl",
    "expand" : {
      "firstName" : "First Name",
      "lastName" : "Last Name",
      "agentId" : "63dcdf380b16aa5b308e40d5",
      "isAgent" : true,
      "isBrokerage" : true,
      "brokerageId" : "63dcdf380b16aa5b308e40d5"
    },
    "pin" : 7987,
    "tennantId" : "tenantId",
    "expire" : "2023-02-13T15:59:22.684Z",
    "_id" : "63dcdf380b16aa5b308e40d5"
  }, {
    "code" : "asd5s",
    "invalidUrl" : "https://domain.com/invalidUrl",
    "active" : true,
    "veShortUrl" : "https://domain.com/ve/shortUrl",
    "transferId" : "00000000-0000-0000-0000-000000000000",
    "pinShortUrl" : "https://domain.com/pin/1985",
    "userId" : "63dcdf380b16aa5b308e40d5",
    "url" : "https://domain.com/longUrl",
    "expand" : {
      "firstName" : "First Name",
      "lastName" : "Last Name",
      "agentId" : "63dcdf380b16aa5b308e40d5",
      "isAgent" : true,
      "isBrokerage" : true,
      "brokerageId" : "63dcdf380b16aa5b308e40d5"
    },
    "pin" : 7987,
    "tennantId" : "tenantId",
    "expire" : "2023-02-13T15:59:22.684Z",
    "_id" : "63dcdf380b16aa5b308e40d5"
  }, {
    "code" : "asd5s",
    "invalidUrl" : "https://domain.com/invalidUrl",
    "active" : true,
    "veShortUrl" : "https://domain.com/ve/shortUrl",
    "transferId" : "00000000-0000-0000-0000-000000000000",
    "pinShortUrl" : "https://domain.com/pin/1985",
    "userId" : "63dcdf380b16aa5b308e40d5",
    "url" : "https://domain.com/longUrl",
    "expand" : {
      "firstName" : "First Name",
      "lastName" : "Last Name",
      "agentId" : "63dcdf380b16aa5b308e40d5",
      "isAgent" : true,
      "isBrokerage" : true,
      "brokerageId" : "63dcdf380b16aa5b308e40d5"
    },
    "pin" : 7987,
    "tennantId" : "tenantId",
    "expire" : "2023-02-13T15:59:22.684Z",
    "_id" : "63dcdf380b16aa5b308e40d5"
  }, {
    "code" : "asd5s",
    "invalidUrl" : "https://domain.com/invalidUrl",
    "active" : true,
    "veShortUrl" : "https://domain.com/ve/shortUrl",
    "transferId" : "00000000-0000-0000-0000-000000000000",
    "pinShortUrl" : "https://domain.com/pin/1985",
    "userId" : "63dcdf380b16aa5b308e40d5",
    "url" : "https://domain.com/longUrl",
    "expand" : {
      "firstName" : "First Name",
      "lastName" : "Last Name",
      "agentId" : "63dcdf380b16aa5b308e40d5",
      "isAgent" : true,
      "isBrokerage" : true,
      "brokerageId" : "63dcdf380b16aa5b308e40d5"
    },
    "pin" : 7987,
    "tennantId" : "tenantId",
    "expire" : "2023-02-13T15:59:22.684Z",
    "_id" : "63dcdf380b16aa5b308e40d5"
  } ],
  "count" : 0,
  "searchBy" : "code",
  "pageSize" : 10,
  "orderBy" : "veShortUrl",
  "from" : "2023-02-13T15:59:22.684Z",
  "page" : 1,
  "to" : "2023-02-13T15:59:22.684Z",
  "userId" : "63dcdf380b16aa5b308e40d5"
}

shortURLPublic

getShortURLByCode

Get Single Short Url Data by code.

Returns the Short Url Full Data for the given code.

Requires Authentication: false

Parameters

tenantID (required) - TYPE: string - Tennant ID
code (required) - TYPE: string - Short URL Code


const response = await smartVideoSDK.shortURLPublic.getShortURLByCode({
    tenantID,
    code
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<SingleShortUrlPublicResponse>

Example Response:

{
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}

getShortURLByPin

Get Short Url by Pin.

Returns the Long Url for the given Pin.

Requires Authentication: false

Parameters

tenantID (required) - TYPE: string - Tennant ID
pin (required) - TYPE: string - Short URL Pin


const response = await smartVideoSDK.shortURLPublic.getShortURLByPin({
    tenantID,
    pin
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<GetShortURLByPin200Response>

Example Response:

{
  "shortUrl" : "https://domain.com/longUrl"
}

listByTransferId

Get All Short Urls by Transfer ID.

Returns the Short Urls for the given Transfer ID.

Requires Authentication: false

Parameters

tenantID (required) - TYPE: string - Tennant ID
transferID (required) - TYPE: string - Transfer ID


const response = await smartVideoSDK.shortURLPublic.listByTransferId({
    tenantID,
    transferID
});

console.log(response.data); // response

Return Type

returns: AxiosPromise<arraySingleShortUrlPublicResponse>

Example Response:

[ {
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}, {
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}, {
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}, {
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
}, {
  "code" : "asd5s",
  "pin" : 7987,
  "expire" : "2023-02-13T15:59:22.684Z",
  "invalidUrl" : "https://domain.com/invalidUrl",
  "active" : true,
  "_id" : "63dcdf380b16aa5b308e40d5",
  "url" : "https://domain.com/longUrl"
} ]

Objects Reference

ASCShortURL

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------|

AuthenticatePartner200Response

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | token | string | | [optional] [default to undefined] | | token_expiration | number | | [optional] [default to undefined] |

AuthenticatePartner400Response

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | error | string | | [optional] [default to undefined] |

CallbackObject

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | genesys | CallbackObjectGenesys | | [optional] [default to undefined] | | videoengager | CallbackObjectVideoengager | | [optional] [default to undefined] | | icsCalendarData | string | ics Data, can be downloaded as ics file, and then send as attachment in the mail | [optional] [default to undefined] | | emailSent | boolean | wether notification email has been send to visitor or not | [optional] [default to undefined] |

CallbackObjectGenesys

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | scriptId | string | | [optional] [default to undefined] | | queueId | string | | [optional] [default to undefined] | | conversation | CallbackObjectGenesysConversation | | [optional] [default to undefined] |

CallbackObjectGenesysConversation

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | id | string | | [default to undefined] |

CallbackObjectVideoengager

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | autoAnswer | boolean | | [default to undefined] | | name | string | visitor Name | [default to undefined] | | email | string | visitor Email | [default to undefined] | | phone | string | visitor Phone | [default to undefined] | | subject | string | subject | [default to undefined] | | meetingUrl | string | Visitor Join Meeting URL | [default to undefined] | | code | string | Short URL Code for generating short URL | [default to undefined] | | date | number | scheduled Time | [default to undefined] | | agentUrl | string | Agent Meeting URL, Only Available upon creation | [optional] [default to undefined] | | created | string | Created At | [default to undefined] | | duration | number | Duration of callback in minutes | [default to undefined] | | scheduleId | string | scheduleId | [default to undefined] | | customAttributes | { [key: string]: string; } | Custom Attributes | [optional] [default to undefined] | | active | boolean | wether this callback is active or canceled | [default to undefined] |

CallbackUpdateError

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | error | string | | [optional] [default to undefined] |

CallbackUpdateRequest

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | date | string | Date to update callback to (ISO 8601 format), Note that date should be in the future and not more than 30 days from now | [default to undefined] |

CallbacksList

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | data | Array<CallbackObject> | | [optional] [default to undefined] | | from | string | | [optional] [default to undefined] | | to | string | | [optional] [default to undefined] | | count | number | | [optional] [default to undefined] | | page | number | | [optional] [default to undefined] | | pageSize | number | | [optional] [default to undefined] | | orderBy | string | | [optional] [default to undefined] | | asc | number | | [optional] [default to undefined] | | preferedAgent | string | | [optional] [default to undefined] | | active | boolean | | [optional] [default to undefined] | | queueId | string | | [optional] [default to undefined] | | searchBy | string | | [optional] [default to undefined] | | searchString | string | | [optional] [default to undefined] |

CreateCallbackRequest

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | preferedAgent | string | used to add agent ID preferred routing, MUST exist if callbackOwned is True; | [optional] [default to undefined] | | callbackOwned | boolean | used to give prefered Agent ownership of the callback, will not work without prefered Agent ID | [optional] [default to undefined] | | firstname | string | | [default to undefined] | | lastname | string | | [optional] [default to undefined] | | customer_email | string | | [default to undefined] | | creator | string | Identify the creater of the scheduled meeting. | [optional] [default to undefined] | | _customer_number | string | | [default to undefined] | | _desired_time | string | | [default to undefined] | | veSubject | string | | [optional] [default to undefined] | | customer_subject | string | | [optional] [default to undefined] | | scriptId | string | used to add script ID to the callback (if not provided, default script in settings will be used) | [optional] [default to undefined] | | queueId | string | used to add queue ID to the callback (if not provided, default script in settings will be used) | [optional] [default to undefined] |

CreateShortURLRequest

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | url | string | URL to be shortened | [default to undefined] | | expire | string | Date - ISO 8601 | [optional] [default to undefined] | | transferId | string | ShortURL ID | [optional] [default to undefined] | | code | string | ShortURL code | [optional] [default to undefined] | | invalidUrl | string | Invalid URL | [optional] [default to undefined] | | pin | number | Pin code | [optional] [default to undefined] |

DefaultError

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | error | string | | [optional] [default to undefined] |

ExpandedData

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | firstName | string | First name | [optional] [default to undefined] | | lastName | string | Last name | [optional] [default to undefined] | | isBrokerage | boolean | | [optional] [default to true] | | isAgent | boolean | | [optional] [default to true] | | agentId | string | User ID | [optional] [default to undefined] | | brokerageId | string | User ID | [optional] [default to undefined] |

GetShortURLByPin200Response

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | shortUrl | string | URL to be shortened | [optional] [default to undefined] |

OrderByShortURL

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------|

SearchByShortURL

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------|

SettingsPublicResponse

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | branding | SettingsPublicResponseBranding | | [optional] [default to undefined] | | widgetSize | SettingsPublicResponseWidgetSize | | [optional] [default to undefined] | | bandwidth | SettingsPublicResponseBandwidth | | [optional] [default to undefined] | | backgroundUrl | string | | [optional] [default to undefined] | | frontMessage | string | | [optional] [default to undefined] | | waitingMessage | string | | [optional] [default to undefined] | | viewWidget | string | | [optional] [default to undefined] | | defaultGroup | string | | [optional] [default to undefined] | | locale | string | | [optional] [default to undefined] | | showTooltipVideo | boolean | | [optional] [default to undefined] | | startThreeWayCall | boolean | | [optional] [default to undefined] | | disableAnonymousThreeWayCall | boolean | | [optional] [default to undefined] | | showEmail | boolean | | [optional] [default to undefined] | | dropAnimation | boolean | | [optional] [default to undefined] | | randomTooltip | boolean | | [optional] [default to undefined] | | tooltipAvatar | boolean | | [optional] [default to undefined] | | startWidget | boolean | | [optional] [default to undefined] | | privateAccess | boolean | | [optional] [default to undefined] | | enableReplaceVideoTracks | boolean | | [optional] [default to undefined] | | enablePrivate | boolean | | [optional] [default to undefined] | | hideStatus | boolean | | [optional] [default to undefined] | | cameraOn | boolean | | [optional] [default to undefined] | | agentCameraOn | boolean | | [optional] [default to undefined] | | recordingInNewTab | boolean | | [optional] [default to undefined] | | chatOriented | boolean | | [optional] [default to undefined] | | constTooltip | boolean | | [optional] [default to undefined] | | callWrapUp | boolean | | [optional] [default to undefined] | | torch | boolean | | [optional] [default to undefined] | | agentReplyTimeOut | number | | [optional] [default to undefined] | | noCallRedirectTimeoutSec | number | | [optional] [default to undefined] | | enablePin | boolean | | [optional] [default to undefined] | | pin_shorturl | string | | [optional] [default to undefined] | | isPopup | boolean | | [optional] [default to undefined] | | disableAgentStatus | boolean | | [optional] [default to undefined] | | enablePrecallWorkflow | boolean | | [optional] [default to undefined] | | enablePoorConnectionDectect | boolean | | [optional] [default to undefined] | | enableGenesysKpiFeature | boolean | | [optional] [default to undefined] | | firstName | string | | [optional] [default to undefined] | | lastName | string | | [optional] [default to undefined] | | company | string | | [optional] [default to undefined] | | tennantId | string | | [optional] [default to undefined] | | shortUrl | string | | [optional] [default to undefined] | | fileTransfer | SettingsPublicResponseFileTransfer | | [optional] [default to undefined] | | email | string | | [optional] [default to undefined] | | organizationId | string | | [optional] [default to undefined] | | contactEmail | string | | [optional] [default to undefined] | | id | string | | [optional] [default to undefined] |

SettingsPublicResponseBandwidth

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | threshold | number | | [optional] [default to undefined] | | warningMessage | string | | [optional] [default to undefined] |

SettingsPublicResponseBranding

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | buttons | SettingsPublicResponseBrandingButtons | | [optional] [default to undefined] | | isPipActive | boolean | | [optional] [default to undefined] | | allowEditInviteUrl | boolean | | [optional] [default to undefined] | | domainUrl | string | domain URL for the agent short URL | [optional] [default to undefined] | | text | string | | [optional] [default to undefined] | | URL | string | domain URL of organization | [optional] [default to undefined] | | logo | string | Organization logo | [optional] [default to undefined] | | genesysActive | boolean | | [optional] [default to undefined] | | talkdeskActive | boolean | | [optional] [default to undefined] | | redirectUrl | string | domain URL to redirect to after visitor call ends | [optional] [default to undefined] | | invalidUrl | string | domain URL to sent to when short url is invalid | [optional] [default to undefined] | | disablevideourlgeneration | boolean | | [optional] [default to undefined] | | hideCustomerRecordingIndicator | boolean | | [optional] [default to undefined] | | hideAgentRecordingIndicator | boolean | | [optional] [default to undefined] | | visitorScreenShareControl | boolean | | [optional] [default to undefined] | | agentScreenShareControl | boolean | | [optional] [default to undefined] | | visitorBackgroundUrl | string | | [optional] [default to undefined] | | visitorShowPrecall | boolean | | [optional] [default to undefined] | | zoomButton | boolean | | [optional] [default to undefined] | | agentCameraControl | boolean | | [optional] [default to undefined] | | visitorCameraControl | boolean | | [optional] [default to undefined] | | activateCustomShortUrl | boolean | | [optional] [default to undefined] | | customShortUrl | SettingsPublicResponseBrandingCustomShortUrl | | [optional] [default to undefined] | | allowAllsidebarItems | boolean | | [optional] [default to undefined] | | inviteUrl | string | domain URL for visitor short URL | [optional] [default to undefined] |

SettingsPublicResponseBrandingButtons

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | wd_v_snapshot | boolean | | [optional] [default to undefined] | | wd_v_annotation | boolean | | [optional] [default to undefined] | | wd_v_video | boolean | | [optional] [default to undefined] | | wd_v_blur | boolean | | [optional] [default to undefined] |

SettingsPublicResponseBrandingCustomShortUrl

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | enabled | boolean | | [optional] [default to undefined] | | url | string | custom page URL to handle custom inbound scenario | [optional] [default to undefined] | | env | string | environment for custom page URL | [optional] [default to undefined] | | publicKey | string | Public key for encryption | [optional] [default to undefined] |

SettingsPublicResponseFileTransfer

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | enable | boolean | | [optional] [default to undefined] | | disableAgent | boolean | | [optional] [default to undefined] | | disableVisitor | boolean | | [optional] [default to undefined] |

SettingsPublicResponseWidgetSize

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | width | number | | [optional] [default to undefined] | | height | number | | [optional] [default to undefined] |

ShortUrlCreateResponse

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | _id | string | ShortURL ID | [optional] [default to undefined] | | url | string | URL to be shortened | [optional] [default to undefined] | | code | string | ShortURL code | [optional] [default to undefined] | | pin | number | Pin code | [optional] [default to undefined] | | invalidUrl | string | Invalid URL | [optional] [default to undefined] | | pinShortUrl | string | Short URL with pin | [optional] [default to undefined] | | veShortUrl | string | Short URL with code | [optional] [default to undefined] | | transferId | string | Transfer ID | [optional] [default to undefined] | | tennantId | string | Tennant ID | [optional] [default to undefined] | | userId | string | User ID | [optional] [default to undefined] | | active | boolean | | [optional] [default to true] | | expire | string | Date - ISO 8601 | [optional] [default to undefined] |

ShortUrlListResponse

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | data | Array<SingleShortUrlManager> | | [optional] [default to undefined] | | page | number | Current Page number | [optional] [default to undefined] | | pageSize | number | Page Size | [optional] [default to 100] | | count | number | | [optional] [default to undefined] | | searchString | string | | [optional] [default to undefined] | | searchBy | SearchByShortURL | | [optional] [default to undefined] | | orderBy | OrderByShortURL | | [optional] [default to undefined] | | asc | ASCShortURL | | [optional] [default to undefined] | | from | string | Date - ISO 8601 | [optional] [default to undefined] | | to | string | Date - ISO 8601 | [optional] [default to undefined] | | userId | string | User ID | [optional] [default to undefined] |

SingleShortUrlManager

Properties

| Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | _id | string | ShortURL ID | [optional] [default to undefined] | | url | string | URL to be shortened | [optional] [default to undefined] | | code | string | ShortURL code | [optional] [default to undefined] | | pin | number | Pin code | [optional] [default to undefined] | | invalidUrl | string | Invalid URL | [optional] [default to undefined] | | pinShortUrl | string | Short URL with pin | [optional] [default to undefined] | | veShortUrl | string | Short URL with code | [optional] [default to undefined] | | tennantId | string | Tennant ID | [optional] [default to undefined] | | transferId | string | Transfer ID | [optional] [default to undefined] | | userId | string | User ID | [optional] [default to undefined] | | active | boolean | | [optional] [default to true] | | expire | string | Date - ISO 8601 | [optional] [default to undefined] | | expand | ExpandedData | | [optional] [default to undefined] |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

VideoEngager Javascript SDK

Table of Contents

API References

Installation

Browser

Getting Started

Client API Reference

authentication

authenticatePartner

Parameters

Return Type

callbacks

createCallback

Parameters

Return Type

deleteCallbackByConversationId

Parameters

Return Type

getCallbackByConversationId

Parameters

Return Type

getTennantAvailability

Parameters

Return Type

getTennantCalendar

Parameters

Return Type

listCallbacks

Parameters

Return Type

removeCallbackByScheduleId

Parameters

Return Type

updateCallbackByConversationId

Parameters

Return Type

settingsPublic

getPublicSettingsByTennantId

Parameters

Return Type

shortURLAuthenticated

createShortURL

Parameters

Return Type

deactivateShortURL

Parameters

Return Type

getShortURLsForTennant

Parameters

Return Type

shortURLPublic

getShortURLByCode

Parameters

Return Type

getShortURLByPin

Parameters

Return Type

listByTransferId

Parameters

Return Type

Objects Reference

ASCShortURL

Properties

AuthenticatePartner200Response

Properties

AuthenticatePartner400Response

Properties

CallbackObject

Properties

CallbackObjectGenesys

Properties

CallbackObjectGenesysConversation

Properties

CallbackObjectVideoengager