Namespace: Call

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

Properties:

Name	Type	Default	Description
AUTO_CALLBACK	string	AUTO_CALLBACK	Auto callback.
AUTOMATIC_CALL_DISTRIBUTION_EXTERNAL	string	AUTOMATIC_CALL_DISTRIBUTION_EXTERNAL	Automatic call distribution external.
AUTOMATIC_CALL_DISTRIBUTION_INTERNAL	string	AUTOMATIC_CALL_DISTRIBUTION_INTERNAL	Automatic call distribution internal.
DIRECT_AGENT_CALL_EXTERNAL	string	DIRECT_AGENT_CALL_EXTERNAL	Direct agent call external.
DIRECT_AGENT_CALL_INTERNAL	string	DIRECT_AGENT_CALL_INTERNAL	Direct agent call internal.
DIRECT_AGENT_CALL_PRIORITY	string	DIRECT_AGENT_CALL_PRIORITY	Direct agent call priority.
EXTERNAL	string	EXTERNAL	External.
HOLD_RECALL	string	HOLD_RECALL	Hold recall.
INTERCOM	string	INTERCOM	Intercom.
INTERNAL	string	INTERNAL	Internal.
NONE	string	NONE	None.
PRIORITY	string	PRIORITY	Priority.
TRANSFER_RECALL	string	TRANSFER_RECALL	Transfer recall.
UNSPECIFIED	string	UNSPECIFIED	Unspecified.

See:

• {AvayaClientServices.Services.Call.Call#getAlertType}

<static> AudioMode :string

Enumeration describing possible audio modes for the call.

Type:

• string

Properties:

Name	Type	Default	Description
SEND_RECEIVE	string	SEND_RECEIVE	Bi-directional audio. Same as setting audio mode to ENABLE.
DISABLE	string	DISABLE	Disabled audio
ENABLE	string	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
BUSY	string	BUSY	Busy.
FORBIDDEN	string	FORBIDDEN	Forbidden.
TEMPORARILY_UNAVAILABLE	string	TEMPORARILY_UNAVAILABLE	Temporary Unavailable.

<static> CallEndReason :string

Reasons that can be used for ending a call.

Type:

• string

Properties:

Name	Type	Default	Description
CALL_DISCONNECTED	string	CALL_DISCONNECTED	Call ended remotely.
CALL_DISCONNECTED_UNKNOWN_REASON	string	CALL_DISCONNECTED_UNKNOWN_REASON	Call disconnected with an unknown reason.
CALL_ENDED_LOCALLY	string	CALL_ENDED_LOCALLY	Call ended locally.
DISCONNECTED_BY_CONFERENCE_MODERATOR	string	DISCONNECTED_BY_CONFERENCE_MODERATOR	Call disconnected by the conference moderator or administrator
CONFERENCE_TERMINATED	string	CONFERENCE_TERMINATED	The conference was terminated
DTLS_FAILURE	string	DTLS_FAILURE	Call failed due to a DTLS error in the media transport reported by the far end
ICE_FAILURE	string	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_ERROR	string	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_FAILED	string	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.
BUSY	string	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_MISMATCH	string	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_FOUND	string	CALL_NOT_FOUND	Call is not found.
CANCELLED	string	CANCELLED	Current operation is cancelled.
CAPABILITY_NOT_ALLOWED	string	CAPABILITY_NOT_ALLOWED	Operation is not allowed currently.
CODEC_MISMATCH	string	CODEC_MISMATCH	Reported when a VoIP session cannot be established due to incompatibility of codecs between the local and remote parties.
DEVICES_NOT_FOUND	string	DEVICES_NOT_FOUND	Media devices are not found.
MICROPHONE_NOT_FOUND	string	MICROPHONE_NOT_FOUND	Microphone is not found.
MICROPHONE_PERMISSION_DENIED	string	MICROPHONE_PERMISSION_DENIED	Microphone permission denied
MICROPHONE_NOT_ACCESSIBLE	string	MICROPHONE_NOT_ACCESSIBLE	Microphone is not accessible.
SPEAKERS_NOT_FOUND	string	SPEAKERS_NOT_FOUND	Speakers are not found.
CAMERA_NOT_FOUND	string	CAMERA_NOT_FOUND	Camera is not found.
CAMERA_PERMISSION_DENIED	string	CAMERA_PERMISSION_DENIED	Camera permission denied
CAMERA_NOT_ACCESSIBLE	string	CAMERA_NOT_ACCESSIBLE	Camera is not accessible.
FAILED	string	FAILED	Operation has failed. The failure reason was not specified.
TCP_TLS_TURN_NOT_SUPPORTED	string	TCP_TLS_TURN_NOT_SUPPORTED	Edge Turn TLS/TCP error.
ENDED	string	ENDED	Call is ended.
IN_PROGRESS	string	IN_PROGRESS	Operation has failed because another call operation is in progress.
INTERNAL_ERROR	string	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_PARAMETER	string	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_ERROR	string	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_FAILURE	string	MEDIA_CREATION_FAILURE	Reported when local audio and/or video resources cannot be initialized successfully.
MEDIA_START_FAILURE	string	MEDIA_START_FAILURE	Reported when local audio and/or video resources cannot be started successfully.
MULTIPLE_CALLS_NOT_SUPPORTED	string	MULTIPLE_CALLS_NOT_SUPPORTED	Reported when the call server doesn't support multiple simultaneous calls.
MEDIA_PATH_FAILURE	string	MEDIA_PATH_FAILURE	Reported when audio and/or video resources connection failed.
MULTIPLE_VIDEO_CHANNELS_NOT_SUPPORTED	string	MULTIPLE_VIDEO_CHANNELS_NOT_SUPPORTED	Multiple video channels are not supported.
MUTE_STATE_MISMATCH	string	MUTE_STATE_MISMATCH	Mute state mismatch.
NO_AVAILABLE_CALL_APPEARANCE	string	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_AUTHORIZED	string	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_FOUND	string	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_LICENSED	string	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_REGISTERED	string	NOT_REGISTERED	Reported when an operation fails because the server assumes that the user is not registered.
OVERCONSTRAINED	string	OVERCONSTRAINED	Reported when no acceptable device constraint is found.
REDIRECTED	string	REDIRECTED	Operation was redirected to another destination.
REGISTRATION_TERMINATED	string	REGISTRATION_TERMINATED	Reported when an attempt to register call services is rejected most likely due to maximum device limits has reached.
REMOTE_CALL_NOT_ALERTING	string	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_FAILURE	string	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_ERROR	string	SEND_ERROR	Reported when a network message could not be sent due to a network connection error.
SERVER_ERROR	string	SERVER_ERROR	Reported when the request has failed due to an internal server error.
SESSION_ID_NOT_FOUND	string	SESSION_ID_NOT_FOUND	Reported when an invalid or expired sessionId is used for an MPaaS call.
SESSION_ID_ALREADY_CONNECTED	string	SESSION_ID_ALREADY_CONNECTED	Reported when the same sessionId is used for two MPaaS calls at the same time.
SUCCESS	string	SUCCESS	Operation completed successfully. This return code is not used.
TIMEOUT	string	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.
TRANSPORT_ERROR	string	TRANSPORT_ERROR	Reported when the request could not be sent to the network server.
UNDEFINED	string	UNDEFINED	Operation has failed because an unknown error occurred. This error code is not used.
UNHANDLED_VIDEO_DIRECTION	string	UNHANDLED_VIDEO_DIRECTION	Unhandled video direction.
USER_NOT_FOUND	string	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_UNAVAILABLE	string	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_DENIED	string	VIDEO_DENIED	Reported when a mid-call video add request was denied by the remote party.
VIDEO_DEESCALATION_NOT_SUPPORTED	string	VIDEO_DEESCALATION_NOT_SUPPORTED	Reported when browser does not support video deescalation from a remote endpoint/gateway.
WEBRTC_NOT_SUPPORTED	string	WEBRTC_NOT_SUPPORTED	WEBRTC is not supported by the browser.
STATISTICS_UNAVAILABLE	string	STATISTICS_UNAVAILABLE	Statistics information is unavailable.
MEDIA_PRESERVED	string	MEDIA_PRESERVED	Signaling path for the call has failed but media is preserved.
SERVICE_TEMPORARILY_UNAVAILABLE	string	SERVICE_TEMPORARILY_UNAVAILABLE	Reported when service is temporarily unavailable.
SERVICE_UNAVAILABLE	string	SERVICE_UNAVAILABLE	Reported when service is unavailable.
VIDEO_ONLY_CALL_NOT_SUPPORTED	string	VIDEO_ONLY_CALL_NOT_SUPPORTED	Video only call is not supported.
VIDEO_REJECTION_NOT_SUPPORTED	string	VIDEO_REJECTION_NOT_SUPPORTED	Video was rejected by far-end and the browser does not support reverting to audio only.
COLLABORATION_ONLY_CALL_NOT_SUPPORTED	string	COLLABORATION_ONLY_CALL_NOT_SUPPORTED	Collaboration only call is not supported.
NETWORK_EVENTS_SUBSCRIPTION_UNAVAILABLE	string	NETWORK_EVENTS_SUBSCRIPTION_UNAVAILABLE	Network events url to subscriptions is undefined
NETWORK_EVENTS_SUBSCRIPTION_FAILED	string	NETWORK_EVENTS_SUBSCRIPTION_FAILED	Network events subscriptions request failed
MEDIA_SERVICE_UNAVAILABLE	string	MEDIA_SERVICE_UNAVAILABLE	Media service is unavailable.
INVALID_ACCEPTED_EVENTS	string	INVALID_ACCEPTED_EVENTS	Invalid events to subscribe.

<static> CallProtocolType :string

Enumeration describing possible call protocol types.

Type:

• string

Properties:

Name	Type	Default	Description
APPLICATION	string	APPLICATION	Application protocol type.
HTTP	string	HTTP	HTTP protocol type.

<static> CallStates :string

Enumeration describing possible call states.

Type:

• string

Properties:

Name	Type	Default	Description
FAR_END_RENEGOTIATING	string	far_end_renegotiating	Call is being renegotiated by the far-end of the call.
IDLE	string	idle	The initial state of the call prior to it was started.
IGNORED	string	ignored	Indicates that the call previously ALERTING, was ignored by the local user.
INITIATING	string	initiating	Indicates that the call is initiating after it was started but before the remote party is alerting (ringing).
REMOTE_ALERTING	string	remote_alerting	Indicates that the remote party is currently alerting (ringing).
RENEGOTIATING	string	renegotiating	The call is renegotiating by the local user to perform an operation such as adding video.
FAILED	string	failed	The call failed to start or was ended abnormally.
ALERTING	string	alerting	The call is alerting locally.
HELD	string	held	The call was held by the local user.
ENDED	string	ended	The call ended.
ENDING	string	ending	The call is in the process of ending.
HOLDING	string	holding	The call is in the process of being put on hold by the local user.
UNHOLDING	string	unholding	The call is in the process of being unheld by the local user.
ESTABLISHED	string	established	The call is currently active.
BEING_TRANSFERRED	string	being_transferred	The remote user is transferring this call to another party.
TRANSFERRING	string	transferring	The local user is transferring this call to another party.

<static> CallType :string

Type:

• string

Properties:

Name	Type	Default	Description
CallTypeDefaultRegisteredService	string	DefaultRegisteredService	Call dials through the UC infrastructure.
CallTypeHttpMeetMe	string	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
A	string	A
B	string	B
C	string	C
D	string	D
STAR	string	*
POUND	string	#
ONE	string	1
TWO	string	2
THREE	string	3
FOUR	string	4
FIVE	string	5
SIX	string	6
SEVEN	string	7
EIGHT	string	8
NINE	string	9
ZERO	string	0

<static, readonly> MediaDirection :string

Enumeration describing DTMF tones.

Type:

• string

Properties:

Name	Type	Default	Description
RECV_ONLY	string	recvonly	Media is received but not sent.
SEND_ONLY	string	sendonly	Media is sent but no media is received.
SEND_RECV	string	sendrecv	Media is sent and received.
INACTIVE	string	inactive	No media flow. No media is transmitted or received.
DISABLE	string	disable	Media direction has been disabled.
UNDEFINED	string	undefined	Media direction has not been set.

<static> NoiseReductionSetting :string

Type:

• string

Properties:

Name	Type	Default	Description
ENABLED	string	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_CLIENT	string	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_CLIENT	string	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_ALL	string	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
ACCEPTED	string	ACCEPTED	Transfer accepted.
NONE	string	NONE	None.
REMOTE_CALL_ESTABLISHED	string	REMOTE_CALL_ESTABLISHED	Remote call is established.
REMOTE_CALL_IN_PROGRESS	string	REMOTE_CALL_IN_PROGRESS	Remote call is in progress.
REMOTE_CALL_STARTED	string	REMOTE_CALL_STARTED	Remote call is started.
STARTED	string	STARTED	Transfer is started.

<static> VideoChannelDisabledReason :string

Enumeration describing possible reasons for disabling a video channel.

Type:

• string

Properties:

Name	Type	Default	Description
NONE	string	none	Associated video channel object is enabled.
DISABLED_BY_LOCAL_USER	string	disabledByLocalUser	The local user removed video from the call.
DISABLED_BY_REMOTE_USER	string	disabledByRemoteUser	The remote user removed video from the call.
DISABLED_DUE_TO_CPU_OVERLOAD	string	disabledDueToCpuOverload	High CPU utilization is detected.
DISABLED_DUE_TO_INSUFFICIENT_BANDWIDTH	string	disabledDueToInsufficientBandwidth	There is insufficient bandwidth to support video.
DISABLED_DUE_TO_LOCAL_PLATFORM_LIMITATIONS	string	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_SELECTION	string	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_PLUGIN	string	disabledDueToMissingH264Plugin	Missing H.264 plugin

<static> VideoMode :string

Enumeration describing possible video modes for the call.

Type:

• string

Properties:

Name	Type	Default	Description
SEND_RECEIVE	string	SEND_RECEIVE	Bi-directional video.
RECEIVE_ONLY	string	RECEIVE_ONLY	Receive-only video.
SEND_ONLY	string	SEND_ONLY	Send-only video.
INACTIVE	string	INACTIVE	Inactive. Returns if video for the call is inactive.
DISABLE	string	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
INDEFINITE	string	indefinite	Indefinite.
OFF	string	off	Off.
SUPPORTED	string	supported	Supported.