Emitted after the HTMLAudioElement for the remote audio is created.
The HTMLAudioElement.
Emitted when the Call is canceled.
Emitted when the Call receives an error.
Emitted when a Call receives a message from the backend.
This feature is currently in Beta.
A message object representing the payload that was received from the Twilio backend.
Emitted after calling the Call.sendMessage API.
This event indicates that Twilio has received the message.
This feature is currently in Beta.
A message object that was sent to the Twilio backend.
Emitted when the Call has regained media connectivity.
Emitted when the Call has lost media connectivity and is reconnecting.
The TwilioError that caused the media connectivity loss
Emitted when the Call is rejected.
Emitted when the Call has entered the ringing state.
When using the Dial verb with answerOnBridge=true, the ringing state will begin when
the callee has been notified of the call and will transition into open after the callee accepts the call,
or closed if the call is rejected or cancelled.
Denotes whether there is early media available from the callee.
If true, the Client SDK will automatically play the early media. Sometimes this is ringing,
other times it may be an important message about the call. If false, there is no remote media to play,
so the application may want to play its own outgoing ringtone sound.
Emitted every 50ms with the current input and output volumes, as a percentage of maximum volume, between -100dB and -30dB. Represented by a floating point number.
A floating point number between 0.0 and 1.0 inclusive.
A floating point number between 0.0 and 1.0 inclusive.
Emitted when a call quality metric has returned to normal. You can listen for this event to update the user when a call quality issue has been resolved.
The name of the warning
Emitted when the SDK detects a drop in call quality or other conditions that may indicate the user is having trouble with the call. You can implement callbacks on these events to alert the user of an issue.
To alert the user that an issue has been resolved, you can listen for the warning-cleared event,
which indicates that a call quality metric has returned to normal.
For a full list of conditions that will raise a warning event, check the Voice Insights SDK Events Reference page.
The name of the warning
An object containing data on the warning
Returns caller verification information about the caller. If no caller verification information is available this will return null.
The custom parameters sent to (outgoing) or received by (incoming) the TwiML app.
The temporary CallSid for this call, if it's outbound.
Call parameters received from Twilio for an incoming call.
Audio codec used for this Call. Expecting Call.Codec but will copy whatever we get from RTC stats.
The connect token is available as soon as the call is established and connected to Twilio. Use this token to reconnect to a call via the Device.connect method.
For incoming calls, it is available in the call object after the Device.incomingEvent is emitted. For outgoing calls, it is available after the Call.acceptEvent is emitted.
Whether this Call is incoming or outgoing.
Accept the incoming Call.
Disconnect from the Call.
Get the local MediaStream, if set.
Get the remote MediaStream, if set.
Ignore the incoming Call.
Check whether call is muted
Mute incoming audio.
Whether the incoming audio should be muted. Defaults to true.
Post an event to Endpoint Analytics indicating that the end user has given call quality feedback. Called without a score, this will report that the customer declined to give feedback.
The end-user's rating of the call; an integer 1 through 5. Or undefined if the user declined to give feedback.
The primary issue the end user experienced on the call. Can be: ['one-way-audio', 'choppy-audio', 'dropped-call', 'audio-latency', 'noisy-call', 'echo']
Reject the incoming Call.
Send a string of digits.
Send a message to Twilio. Your backend application can listen for these
messages to allow communication between your frontend and backend applications.
This feature is currently in Beta.
The message object to send.
A voice event sid that uniquely identifies the message that was sent.
Generated using TypeDoc
A Call represents a media and signaling connection to a TwiML application.