Global

Members

(constant) Actors :string

Properties:
Name Type Description
local string
remote string

Actor types

Type:
  • string

(constant) BaseURLs :string

Properties:
Name Type Description
dev string
qa string
qa2 string
qa3 string
qa4 string
staging string
staging2 string
uat string
us string
au string
eu string
ca string
uk string

Base URLs for each boostlingo region

Type:
  • string

(constant) CallTypes :string

Properties:
Name Type Description
video string
voice string

Supported call types

Type:
  • string

(constant) defaultRegion

Default Value:
  • us

The default region to use if one is not specified

(constant) Roles :string

Properties:
Name Type Description
corporateClientAdmin string
corporateClient string
corporateInterpreterAdmin string
corporateInterpreter string
corporateClientRootAdmin string
corporateInterpreterRootAdmin string
administrator string

Roles

Type:
  • string

(constant) VideoCallCss :string

Default Value:
  • {
  "participant": "bl-participant",
  "participantRemote": "bl-participant--remote",
  "participantLocal": "bl-participant--local",
  "participantDialIn": "bl-participant--dial-in"
}
Properties:
Name Type Description
participant string
participantRemote string
participantLocal string
participantDialIn string

CSS classes for participants of a VideoCall

Type:
  • string

(constant) VideoCallDataAttributes :string

Default Value:
  • {
  "participantIdentity": "bl-data-participant-identity",
  "isParticipantRemote": "bl-is-remote-participant",
  "isParticipantDialIn": "bl-is-dial-in-participant"
}
Properties:
Name Type Description
participantIdentity string
isParticipantRemote string
isParticipantDialIn string

Data attributes for participants of a VideoCall

Type:
  • string

(constant) VideoCallEvents :string

Default Value:
  • {
  "localParticipantAttachContainer": "localParticipantAttachContainer",
  "localParticipantDetachContainer": "localParticipantDetachContainer",
  "remoteParticipantAttachContainer": "remoteParticipantAttachContainer",
  "remoteParticipantDetachContainer": "remoteParticipantDetachContainer"
}
Properties:
Name Type Description
localParticipantAttachContainer string
localParticipantDetachContainer string
remoteParticipantAttachContainer string
remoteParticipantDetachContainer string

Events emmitted by a VideoCall

Type:
  • string

Methods

BaseURL(region)

Lookup function for converting region into the proper URL. Uses default region if one is not specified

Parameters:
Name Type Description
region string

Type Definitions

CallData

Properties:
Name Type Description
key string
value string

Call request data

Type:
  • Object

CallDetails

Properties:
Name Type Description
callId number
accountUniqueId number
duration string
timeRequested string
timeAnswered string
timeConnected string

Call Details model

Type:
  • Object

CallDictionaries

Properties:
Name Type Description
version number
languages Array.<Language>
serviceTypes Array.<ServiceType>
genders Array.<Gender>
imageStoreInfo ImageStoreInfo

Call dictionaries

Type:
  • Object

CallRequest

Properties:
Name Type Attributes Description
languageFromId number
languageToId number
serviceTypeId number
genderId number <nullable>
data Array.<CallData> <nullable>

Call request model

Type:
  • Object

Gender

Properties:
Name Type Description
id number
name string

Gender model

Type:
  • Object

ImageStoreInfo

Properties:
Name Type Description
baseUrl string
extension string
urlPattern string
sizes Array.<int>

Image store info

Type:
  • Object

InterlocutorInfo

Properties:
Name Type Description
userAccountId number
firstName string
lastName string
requiredName string
imageKey string
companyName string
rating number

Information about the call participant. ie. Requestor or interpreter

Type:
  • Object

Language

Properties:
Name Type Attributes Description
id number
code string
name string
englishName string
localizedName string
nativeName string
isSignLanguage boolean
isVideoBackstopStaffed boolean
vriPolicyOrder number <nullable>
opiPolicyOrder number <nullable>

Language model

Type:
  • Object

RemoteParticipant

Properties:
Name Type Description
id string
identity string

Remote Participant model

Type:
  • Object

ServiceType

Properties:
Name Type Description
id number
name string

Service types model

Type:
  • Object