Classes
- AudioChannel
- AudioDetails
- Call
- CallCreationInfo
- CallEndEvent
- CallException
- CallManager
- Calls
- ConferenceEntryOptions
- RingbackToneURLs
- UserToUserInfo
- VideoChannel
- VideoDetails
Members
-
<static> AlertType :string
-
Enumeration describing possible call alert types for an incoming call.
Type:
- string
See:
Properties:
Name Type Default Description AUTO_CALLBACKstring AUTO_CALLBACK Auto callback.
AUTOMATIC_CALL_DISTRIBUTION_EXTERNALstring AUTOMATIC_CALL_DISTRIBUTION_EXTERNAL Automatic call distribution external.
AUTOMATIC_CALL_DISTRIBUTION_INTERNALstring AUTOMATIC_CALL_DISTRIBUTION_INTERNAL Automatic call distribution internal.
DIRECT_AGENT_CALL_EXTERNALstring DIRECT_AGENT_CALL_EXTERNAL Direct agent call external.
DIRECT_AGENT_CALL_INTERNALstring DIRECT_AGENT_CALL_INTERNAL Direct agent call internal.
DIRECT_AGENT_CALL_PRIORITYstring DIRECT_AGENT_CALL_PRIORITY Direct agent call priority.
EXTERNALstring EXTERNAL External.
HOLD_RECALLstring HOLD_RECALL Hold recall.
INTERCOMstring INTERCOM Intercom.
INTERNALstring INTERNAL Internal.
NONEstring NONE None.
PRIORITYstring PRIORITY Priority.
TRANSFER_RECALLstring TRANSFER_RECALL Transfer recall.
UNSPECIFIEDstring UNSPECIFIED Unspecified.
-
<static> AudioMode :string
-
Enumeration describing possible audio modes for the call.
Type:
- string
Properties:
Name Type Default Description SEND_RECEIVEstring SEND_RECEIVE Bi-directional audio. Same as setting audio mode to ENABLE.
DISABLEstring DISABLE Disabled audio
ENABLEstring ENABLE Enabled audio
When enabled, audio is set to be send-receive, that is, bidirectional.
-
<static> CallDenialReason :string
-
Reasons that can be used for denying an incoming call.
Type:
- string
Properties:
Name Type Default Description BUSYstring BUSY Busy.
FORBIDDENstring FORBIDDEN Forbidden.
TEMPORARILY_UNAVAILABLEstring TEMPORARILY_UNAVAILABLE Temporary Unavailable.
-
<static> CallEndReason :string
-
Reasons that can be used for ending a call.
Type:
- string
Properties:
Name Type Default Description CALL_DISCONNECTEDstring CALL_DISCONNECTED Call ended remotely.
CALL_DISCONNECTED_UNKNOWN_REASONstring CALL_DISCONNECTED_UNKNOWN_REASON Call disconnected with an unknown reason.
CALL_ENDED_LOCALLYstring CALL_ENDED_LOCALLY Call ended locally.
DISCONNECTED_BY_CONFERENCE_MODERATORstring DISCONNECTED_BY_CONFERENCE_MODERATOR Call disconnected by the conference moderator or administrator
CONFERENCE_TERMINATEDstring CONFERENCE_TERMINATED The conference was terminated
DTLS_FAILUREstring DTLS_FAILURE Call failed due to a DTLS error in the media transport reported by the far end
ICE_FAILUREstring ICE_FAILURE ICE error reported by the far end
-
<static> CallError :string
-
An enumeration of call errors.
Type:
- string
Properties:
Name Type Default Description AUTHENTICATION_ERRORstring AUTHENTICATION_ERROR Reported when local user's authentication with the network has failed. This can happen when user-supplied credentials do not match the credentials the server expects to receive from the end user.
AUTO_HOLD_FAILEDstring AUTO_HOLD_FAILED Reported when a request by the client to start, accept or unhold a call results in an automatic hold of another currently active call and that hold operation fails.
BUSYstring BUSY Reported when the request is rejected by the server due to resource being busy.
For example, a point-to-point call may fail if the called party returns a busy indication, or if there are no local line appearances available on the server side to initiate the call.CALL_STATE_MISMATCHstring CALL_STATE_MISMATCH Reported when the request cannot be supported at the moment due to the current state of the call.
For example, a hold request while the call is being transferred, is not allowed.CALL_NOT_FOUNDstring CALL_NOT_FOUND Call is not found.
CANCELLEDstring CANCELLED Current operation is cancelled.
CAPABILITY_NOT_ALLOWEDstring CAPABILITY_NOT_ALLOWED Operation is not allowed currently.
CODEC_MISMATCHstring CODEC_MISMATCH Reported when a VoIP session cannot be established due to incompatibility of codecs between the local and remote parties.
DEVICES_NOT_FOUNDstring DEVICES_NOT_FOUND Media devices are not found.
MICROPHONE_NOT_FOUNDstring MICROPHONE_NOT_FOUND Microphone is not found.
MICROPHONE_PERMISSION_DENIEDstring MICROPHONE_PERMISSION_DENIED Microphone permission denied
MICROPHONE_NOT_ACCESSIBLEstring MICROPHONE_NOT_ACCESSIBLE Microphone is not accessible.
SPEAKERS_NOT_FOUNDstring SPEAKERS_NOT_FOUND Speakers are not found.
CAMERA_NOT_FOUNDstring CAMERA_NOT_FOUND Camera is not found.
CAMERA_PERMISSION_DENIEDstring CAMERA_PERMISSION_DENIED Camera permission denied
CAMERA_NOT_ACCESSIBLEstring CAMERA_NOT_ACCESSIBLE Camera is not accessible.
CAMERA_INITIALIZED_LATEstring CAMERA_INITIALIZED_LATE Camera didn't initialize until allowedCameraInitDelay milliseconds after the call was established.
FAILEDstring FAILED Operation has failed. The failure reason was not specified.
TCP_TLS_TURN_NOT_SUPPORTEDstring TCP_TLS_TURN_NOT_SUPPORTED Edge Turn TLS/TCP error.
ENDEDstring ENDED Call is ended.
IN_PROGRESSstring IN_PROGRESS Operation has failed because another call operation is in progress.
INTERNAL_ERRORstring INTERNAL_ERROR Operation has failed due to an internal error.
For example, if the network connection is lost after the API call is made by the application but before the API call can be processed, this error code is returned.INVALID_PARAMETERstring INVALID_PARAMETER Reported when an invalid parameter is used for the request.
For example, if the application tries to add a participant but provides an empty participant address, this error is reported.LINE_RESERVATION_ERRORstring LINE_RESERVATION_ERROR Reported when a line reservation attempt is failed by the server. It should be noted that the line appearance id and the line appearance owner are required to reserve a line appearance when the call is initiated on a bridged line appearance.
If, for some reason, the line reservation request fails, this error code is reported.
This error code is only applicable to communication system environments where bridging and bridged line appearances are supported.MEDIA_CREATION_FAILUREstring MEDIA_CREATION_FAILURE Reported when local audio and/or video resources cannot be initialized successfully.
MEDIA_START_FAILUREstring MEDIA_START_FAILURE Reported when local audio and/or video resources cannot be started successfully.
MULTIPLE_CALLS_NOT_SUPPORTEDstring MULTIPLE_CALLS_NOT_SUPPORTED Reported when the call server doesn't support multiple simultaneous calls.
MEDIA_PATH_FAILUREstring MEDIA_PATH_FAILURE Reported when audio and/or video resources connection failed.
MULTIPLE_VIDEO_CHANNELS_NOT_SUPPORTEDstring MULTIPLE_VIDEO_CHANNELS_NOT_SUPPORTED Multiple video channels are not supported.
MUTE_STATE_MISMATCHstring MUTE_STATE_MISMATCH Mute state mismatch.
NO_AVAILABLE_CALL_APPEARANCEstring NO_AVAILABLE_CALL_APPEARANCE Reported when the local user call initiation attempt fails because the Avaya Communication Manager has no idle line appearance available for the call.
NOT_AUTHORIZEDstring NOT_AUTHORIZED Reported when add or remove operations of the participant cannot be supported because the local user does not have moderator privileges to perform these actions.
NOT_FOUNDstring NOT_FOUND Reported when the called party address is not known to the server.
For example, if the user dials an invalid telephone number, this error code is reported.NOT_LICENSEDstring NOT_LICENSED Reported when an operation is denied because the user does not have the license to perform the operation.
For example, a video add request may be denied using this error code when the user account is not licensed to support video calls.NOT_REGISTEREDstring NOT_REGISTERED Reported when an operation fails because the server assumes that the user is not registered.
OVERCONSTRAINEDstring OVERCONSTRAINED Reported when no acceptable device constraint is found.
REDIRECTEDstring REDIRECTED Operation was redirected to another destination.
REGISTRATION_TERMINATEDstring REGISTRATION_TERMINATED Reported when an attempt to register call services is rejected most likely due to maximum device limits has reached.
REMOTE_CALL_NOT_ALERTINGstring REMOTE_CALL_NOT_ALERTING Reported when an attempt to answer an incoming call locally at a remote extension (e.g., at a bridged line appearance extension) has failed because the call was already answered remotely.
REMOTE_MEDIA_PROCESSING_FAILUREstring REMOTE_MEDIA_PROCESSING_FAILURE Reported when the application tries to accept an incoming call, but this attempt fails because the remote audio and/or video information could not be applied to local audio/video resources.
SEND_ERRORstring SEND_ERROR Reported when a network message could not be sent due to a network connection error.
SERVER_ERRORstring SERVER_ERROR Reported when the request has failed due to an internal server error.
SESSION_ID_NOT_FOUNDstring SESSION_ID_NOT_FOUND Reported when an invalid or expired sessionId is used for an MPaaS call.
SESSION_ID_ALREADY_CONNECTEDstring SESSION_ID_ALREADY_CONNECTED Reported when the same sessionId is used for two MPaaS calls at the same time.
SUCCESSstring SUCCESS Operation completed successfully. This return code is not used.
TIMEOUTstring TIMEOUT Reported when local time-out occurs while sending a network message or a response to the message was not received from the server in time.
ICE_GATHERING_TIMEOUTstring ICE_GATHERING_TIMEOUT Reported when no ice candidates are found after ice gathering time elapsed
TRANSPORT_ERRORstring TRANSPORT_ERROR Reported when the request could not be sent to the network server.
UNDEFINEDstring UNDEFINED Operation has failed because an unknown error occurred. This error code is not used.
UNHANDLED_VIDEO_DIRECTIONstring UNHANDLED_VIDEO_DIRECTION Unhandled video direction.
USER_NOT_FOUNDstring USER_NOT_FOUND Reported when the called party address is not known to the server.
For example, if the user dials an invalid telephone number, this error code is reported.USER_TEMPORARILY_UNAVAILABLEstring USER_TEMPORARILY_UNAVAILABLE Reported when the called party has no device registered on his/her behalf, thus, making call setup not possible at this point in time.
VIDEO_DENIEDstring VIDEO_DENIED Reported when a mid-call video add request was denied by the remote party.
VIDEO_DEESCALATION_NOT_SUPPORTEDstring VIDEO_DEESCALATION_NOT_SUPPORTED Reported when browser does not support video deescalation from a remote endpoint/gateway.
WEBRTC_NOT_SUPPORTEDstring WEBRTC_NOT_SUPPORTED WEBRTC is not supported by the browser.
STATISTICS_UNAVAILABLEstring STATISTICS_UNAVAILABLE Statistics information is unavailable.
MEDIA_PRESERVEDstring MEDIA_PRESERVED Signaling path for the call has failed but media is preserved.
SERVICE_TEMPORARILY_UNAVAILABLEstring SERVICE_TEMPORARILY_UNAVAILABLE Reported when service is temporarily unavailable.
SERVICE_UNAVAILABLEstring SERVICE_UNAVAILABLE Reported when service is unavailable.
VIDEO_ONLY_CALL_NOT_SUPPORTEDstring VIDEO_ONLY_CALL_NOT_SUPPORTED Video only call is not supported.
VIDEO_REJECTION_NOT_SUPPORTEDstring VIDEO_REJECTION_NOT_SUPPORTED Video was rejected by far-end and the browser does not support reverting to audio only.
COLLABORATION_ONLY_CALL_NOT_SUPPORTEDstring COLLABORATION_ONLY_CALL_NOT_SUPPORTED Collaboration only call is not supported.
NETWORK_EVENTS_SUBSCRIPTION_UNAVAILABLEstring NETWORK_EVENTS_SUBSCRIPTION_UNAVAILABLE Network events url to subscriptions is undefined
NETWORK_EVENTS_SUBSCRIPTION_FAILEDstring NETWORK_EVENTS_SUBSCRIPTION_FAILED Network events subscriptions request failed
MEDIA_SERVICE_UNAVAILABLEstring MEDIA_SERVICE_UNAVAILABLE Media service is unavailable.
INVALID_ACCEPTED_EVENTSstring INVALID_ACCEPTED_EVENTS Invalid events to subscribe.
VDI_UNAVAILABLEstring VDI_UNAVAILABLE VDI service is unavailable
-
<static> CallProtocolType :string
-
Enumeration describing possible call protocol types.
Type:
- string
Properties:
Name Type Default Description APPLICATIONstring APPLICATION Application protocol type.
HTTPstring HTTP HTTP protocol type.
-
<static> CallStates :string
-
Enumeration describing possible call states.
Type:
- string
Properties:
Name Type Default Description FAR_END_RENEGOTIATINGstring far_end_renegotiating Call is being renegotiated by the far-end of the call.
IDLEstring idle The initial state of the call prior to it was started.
IGNOREDstring ignored Indicates that the call previously ALERTING, was ignored by the local user.
INITIATINGstring initiating Indicates that the call is initiating after it was started but before the remote party is alerting (ringing).
REMOTE_ALERTINGstring remote_alerting Indicates that the remote party is currently alerting (ringing).
RENEGOTIATINGstring renegotiating The call is renegotiating by the local user to perform an operation such as adding video.
FAILEDstring failed The call failed to start or was ended abnormally.
ALERTINGstring alerting The call is alerting locally.
HELDstring held The call was held by the local user.
ENDEDstring ended The call ended.
ENDINGstring ending The call is in the process of ending.
HOLDINGstring holding The call is in the process of being put on hold by the local user.
UNHOLDINGstring unholding The call is in the process of being unheld by the local user.
ESTABLISHEDstring established The call is currently active.
BEING_TRANSFERREDstring being_transferred The remote user is transferring this call to another party.
TRANSFERRINGstring transferring The local user is transferring this call to another party.
-
<static> CallType :string
-
Type:
- string
Properties:
Name Type Default Description CallTypeDefaultRegisteredServicestring DefaultRegisteredService Call dials through the UC infrastructure.
CallTypeHttpMeetMestring HttpMeetMe Join conferencing meetme meeting without going through the UC infrastructure.
-
<static> DTMFTone :string
-
Enumeration describing DTMF tones.
Type:
- string
Properties:
Name Type Default Description Astring A Bstring B Cstring C Dstring D STARstring * POUNDstring # ONEstring 1 TWOstring 2 THREEstring 3 FOURstring 4 FIVEstring 5 SIXstring 6 SEVENstring 7 EIGHTstring 8 NINEstring 9 ZEROstring 0
-
<static, readonly> MediaDirection :string
-
Enumeration describing DTMF tones.
Type:
- string
Properties:
Name Type Default Description RECV_ONLYstring recvonly Media is received but not sent.
SEND_ONLYstring sendonly Media is sent but no media is received.
SEND_RECVstring sendrecv Media is sent and received.
INACTIVEstring inactive No media flow. No media is transmitted or received.
DISABLEstring disable Media direction has been disabled.
UNDEFINEDstring undefined Media direction has not been set.
-
<static> NoiseReductionSetting :string
-
Type:
- string
Properties:
Name Type Default Description ENABLEDstring ENABLED This is the default setting, noise reduction is enabled. If the server notifies the client that server based noise reduction is enabled then client
noise reduction is disabled and server noise reduction is used.DISABLE_CLIENTstring DISABLE_CLIENT Disable client side noise reduction no matter the server setting. Server based noise reduction may still be used if configured on the server.
PREFER_CLIENTstring PREFER_CLIENT Notify the server that client side noise reduction is preferred.
If the server doesn't override this setting server based noise reduction will be disabled and client noise reduction will be enabled.
For servers that don't support noise reduction, client noise reduction is enabled.DISABLE_ALLstring DISABLE_ALL Disable client side noise reduction and notify the server to disable server based noise reduction.
-
<static> TransferProgressCode :string
-
Enumeration describing possible transfer operation progress states.
Type:
- string
Properties:
Name Type Default Description ACCEPTEDstring ACCEPTED Transfer accepted.
NONEstring NONE None.
REMOTE_CALL_ESTABLISHEDstring REMOTE_CALL_ESTABLISHED Remote call is established.
REMOTE_CALL_IN_PROGRESSstring REMOTE_CALL_IN_PROGRESS Remote call is in progress.
REMOTE_CALL_STARTEDstring REMOTE_CALL_STARTED Remote call is started.
STARTEDstring STARTED Transfer is started.
-
<static> VideoChannelDisabledReason :string
-
Enumeration describing possible reasons for disabling a video channel.
Type:
- string
Properties:
Name Type Default Description NONEstring none Associated video channel object is enabled.
DISABLED_BY_LOCAL_USERstring disabledByLocalUser The local user removed video from the call.
DISABLED_BY_REMOTE_USERstring disabledByRemoteUser The remote user removed video from the call.
DISABLED_DUE_TO_CPU_OVERLOADstring disabledDueToCpuOverload High CPU utilization is detected.
DISABLED_DUE_TO_INSUFFICIENT_BANDWIDTHstring disabledDueToInsufficientBandwidth There is insufficient bandwidth to support video.
DISABLED_DUE_TO_LOCAL_PLATFORM_LIMITATIONSstring disabledDueToLocalPlatformLimitations Based on local configuration information and/or the capabilities of the local platform, the video channel cannot be supported.
DISABLED_DUE_TO_LOCAL_LAYOUT_SELECTIONstring disabledDueToLocalLayoutSelection Based on local video layout selection, the video channel cannot be supported.
For example, if the user selects a video layout of 4 video streams but the incoming multi stream switched (MSS) video offer has 9 video streams, 5 of the video streams (streams 5, 6, 7, 8, 9) are disabled.DISABLED_DUE_TO_MISSING_H264_PLUGINstring disabledDueToMissingH264Plugin Missing H.264 plugin
-
<static> VideoMode :string
-
Enumeration describing possible video modes for the call.
Type:
- string
Properties:
Name Type Default Description SEND_RECEIVEstring SEND_RECEIVE Bi-directional video.
RECEIVE_ONLYstring RECEIVE_ONLY Receive-only video.
SEND_ONLYstring SEND_ONLY Send-only video.
INACTIVEstring INACTIVE Inactive. Returns if video for the call is inactive.
DISABLEstring DISABLE Disabled video (i.e. video was removed).
-
<static, readonly> VideoNetworkSignalingType :string
-
Enumeration describing video network signaling types.
Type:
- string
Properties:
Name Type Default Description INDEFINITEstring indefinite Indefinite.
OFFstring off Off.
SUPPORTEDstring supported Supported.