Constructor
-
new CallCreationInfo(remoteAddress, presentationModeOnly, subject)
-
Represents information to be used for call creation.
Parameters:
Name Type Argument Description remoteAddress
string The address of the remote party for the call.
presentationModeOnly
boolean <optional>
The flag indicating if the call should be created as a data-only call.
subject
string <optional>
The subject of the call.
Methods
-
getAuthorizationToken() → {AvayaClientServices.Services.Call.CallCreationInfo.AuthorizationToken}
-
Returns an authorization token that can be used to initiate a single call.
Returns:
-
getAvayaLineId() → {number}
-
Returns the Avaya Line ID for the call to be created.
- Deprecated:
-
- Yes
Returns:
{ number }
-
getAvayaLineOwner() → {string}
-
Returns the Avaya Line owner name for the call.
- Deprecated:
-
- Yes
Returns:
{ string }
-
getCallType() → {AvayaClientServices.Services.Call.CallType}
-
Assigns the call type.
Returns:
-
getConferenceID() → {string|undefined}
-
Returns the conference virtual conference room id.
Returns:
{ string | undefined }
-
getContextId() → {string|undefined}
-
Returns the contextual data id which used in contact center solution
Returns:
{ string | undefined }
-
getMeetMeUserName() → {string|undefined}
-
Returns a display name to represent the user in MeetMe calls.
Returns:
{ string | undefined }
-
getPasscode() → {string|undefined}
-
Returns the PIN of a passcode conference
Returns:
{ string | undefined }
-
getPortalToken() → {string|undefined}
-
Returns the correlation-token provided by Scopia/Portal to correlate Portal session with SIP Signalling
Returns:
{ string | undefined }
-
getRemoteAddress() → {string}
-
Returns the address of the remote party of the call to be created.
Returns:
{ string }
-
getServiceGatewayURL() → {string|*}
-
Returns the Service Gateway URL to establish HTTP connection to the server.
Returns:
{ string | * }
-
getSubject() → {string}
-
Returns the subject of the call to be created.
Returns:
{ string }
-
getUccpURL() → {string|undefined}
-
Returns the URL to establish UCCP connection to a presentation only mode conference.
Returns:
{ string | undefined }
-
isPresentationModeOnly() → {boolean}
-
Returns a flag indicating if the call should be created as a data-only call.
Returns:
{ boolean }
-
setAuthorizationToken(authorizationToken) → {void}
-
Sets an authorization token that can be used to initiate a single
call. This optional field can be used in combination with the
serviceGatewayURL to initialize a guest user call where the user is
allowed to make a single call using the provided token. This is
currently only supported in the Avaya contact center environment.Parameters:
Name Type Description authorizationToken
AvayaClientServices.Services.Call.CallCreationInfo.AuthorizationToken Authorization token needed to initiate a single call.
Returns:
{ void }
-
setCallType(callType)
-
Returns the call type.
Parameters:
Name Type Description callType
AvayaClientServices.Services.Call.CallType
-
setConferenceID(conferenceId)
-
Assigns the conference virtual room id.
Parameters:
Name Type Description conferenceId
string
-
setContextId(contextId)
-
This is an optional field that can be used in a contact center solution.
Parameters:
Name Type Description contextId
string Opaque data representing the id of contextual data stored in the
contact center solution that is associated with this call.
-
setMeetMeUserName(username)
-
Assigns a display name to represent the user in MeetMe calls.
Parameters:
Name Type Description username
string
-
setPasscode(passcode)
-
Assigns the PIN of a passcode conference
Parameters:
Name Type Description passcode
string
-
setPortalToken(token)
-
Assigns the correlation-token provided by Scopia/Portal to correlate Portal session with SIP Signalling
Parameters:
Name Type Description token
string
-
setServiceGatewayURL(serviceGatewayURL)
-
Assigns the Service Gateway URL to establish HTTP connection to the server.
Parameters:
Name Type Description serviceGatewayURL
string
-
setUccpURL(uccpURL)
-
Assigns the URL to establish UCCP connection to a presentation only mode conference.
Parameters:
Name Type Description uccpURL
string
Type Definitions
-
AuthorizationToken
-
Token that can be used to initiate a single call.
Type:
- string