@azure/communication-call-automation package
Clases
| CallAutomationClient |
CallAutomationClient representa un cliente al servicio CallAutomation de Azure Communication. |
| CallConnection |
La clase CallConnection representa las API basadas en la conexión de llamadas. |
| CallMedia |
La clase CallMedia representa las API relacionadas con los medios de llamada. |
| CallRecording |
La clase CallRecording representa las API relacionadas con la grabación de llamadas. |
| StreamingData |
Clase para controlar el análisis de los datos de streaming entrantes. |
Interfaces
| AddParticipantFailed |
No se pudo agregar el evento de participante. |
| AddParticipantOptions |
Opciones para agregar participantes. |
| AddParticipantResult |
Carga de respuesta para agregar participantes a la llamada. |
| AddParticipantSucceeded |
El participante agregó correctamente el evento. |
| AnswerCallOptions |
Opciones para responder a una llamada. |
| AnswerFailed | |
| AudioData |
Datos de streaming de audio. |
| AudioMetadata |
Metadatos de streaming de audio. |
| CallAutomationClientOptions |
Opciones de cliente que se usan para configurar las solicitudes de API de cliente CallAutomation. |
| CallConnected |
Evento cuando se estableció la llamada. |
| CallConnectionProperties |
Propiedades de una conexión de llamada |
| CallDisconnected |
Evento cuando todos los participantes dejaron y se terminó la llamada. |
| CallIntelligenceOptions |
Opciones de IA para la llamada. |
| CallInvite |
Llame a los detalles de la invitación. |
| CallLocator |
Localizador usado para unirse o tomar medidas en una llamada. |
| CallMediaRecognizeChoiceOptions |
Configuración de reconocimiento específica de Opciones. |
| CallMediaRecognizeDtmfOptions |
Configuración de reconocimiento específica de Dtmf. |
| CallMediaRecognizeOptions |
Opciones para configurar la operación recognize. |
| CallMediaRecognizeSpeechOptions |
Configuración de reconocimiento específica de Voz. |
| CallMediaRecognizeSpeechOrDtmfOptions |
Configuración de reconocimiento para Speech o Dtmf |
| CallParticipant |
Modelo de contrato de un participante de llamada de ACS |
| CallResult |
La interfaz utilizada como elemento primario de [action]CallResult |
| CallTransferAccepted |
Evento cuando la solicitud de transferencia se realizó correctamente. |
| CallTransferFailed |
Evento cuando se produjo un error en la solicitud de transferencia. |
| CancelAddParticipantFailed |
No se pudo cancelar el evento de agregar participante. |
| CancelAddParticipantOperationOptions |
Opciones para cancelar la solicitud de agregar participante. |
| CancelAddParticipantOperationResult |
Carga de respuesta para cancelar la solicitud de agregar participante. |
| CancelAddParticipantSucceeded |
Cancelación correcta del evento add participant. |
| ChannelAffinity |
Afinidad de canal para un participante |
| ChoiceResult | |
| ConnectCallOptions |
Opciones para conectar solicitud. |
| ConnectFailed | |
| ContinuousDtmfRecognitionOptions |
Opciones para el reconocimiento continuo de Dtmf. |
| ContinuousDtmfRecognitionStopped |
Evento enviado cuando se detuvo el reconocimiento dtmf continuo. |
| ContinuousDtmfRecognitionToneFailed |
Evento enviado cuando no se pudo reconocer el tono dtmf continuo. |
| ContinuousDtmfRecognitionToneReceived |
Evento enviado cuando el tono dtmf recibió del participante de destino en la llamada. |
| CreateCallFailed | |
| CreateCallOptions |
Opciones para crear una llamada. |
| DownloadRecordingOptions |
Opciones para descargar la grabación. |
| DtmfData |
Datos de streaming Dtmf. |
| DtmfResult | |
| FileSource |
El modelo FileSource. |
| HoldFailed | |
| HoldOptions |
Opciones para contener al participante. |
| ListParticipantsResult |
Carga de respuesta para obtener participantes de la llamada. |
| MediaStreamingFailed | |
| MediaStreamingOptions |
Opciones para la transmisión de medios. |
| MediaStreamingStarted | |
| MediaStreamingStopped | |
| MediaStreamingUpdate | |
| MuteParticipantOption |
Opciones para silenciar al participante. |
| MuteParticipantResult |
Carga de respuesta para silenciar al participante de la llamada. |
| OutStreamingData |
OutboundStreamingAudioData para la carga útil de streaming de audio saliente. |
| ParticipantsUpdated |
Evento cuando se produjo una actualización a los participantes. |
| PlayCanceled |
Evento cuando la operación Cancelar canceló la reproducción multimedia. |
| PlayCompleted |
Evento cuando la reproducción multimedia se completó correctamente. |
| PlayFailed |
Evento cuando se produjo un error en la reproducción multimedia. |
| PlayOptions |
Opciones para reproducir audio. |
| PlaySource |
El modelo de PlaySource. |
| PlayStarted |
Evento cuando la reproducción multimedia se inició correctamente. |
| PlayToAllOptions |
Opciones para reproducirToTodo el audio. |
| RecognitionChoice |
Una opción de reconocimiento |
| RecognizeCanceled |
Evento cuando la operación Cancelar canceló media recognize. |
| RecognizeCompleted |
Evento cuando media recognize se completó correctamente. |
| RecognizeFailed |
Evento cuando se produjo un error en la reconocimiento multimedia. |
| RecordingStateChanged |
Evento cuando se ha cambiado el estado de grabación. |
| RecordingStateResult |
Carga de respuesta para iniciar una grabación de llamadas o obtener el estado de grabación de llamadas. |
| RecordingStorage |
El almacenamiento de grabación |
| RejectCallOptions |
Opciones para rechazar la llamada. |
| RemoveParticipantFailed |
No se pudo quitar el evento de participante. |
| RemoveParticipantResult |
Carga de respuesta para quitar participantes de la llamada. |
| RemoveParticipantSucceeded |
Evento eliminado correctamente por el participante. |
| RemoveParticipantsOption |
Opciones para quitar participantes. |
| RestAddParticipantFailed |
No se pudo agregar el evento de participantes. |
| RestAddParticipantSucceeded |
Los participantes agregaron correctamente el evento. |
| RestAnswerFailed |
No se pudo responder al evento de llamada. |
| RestCallConnected |
Evento conectado de llamada. |
| RestCallDisconnected |
Evento desconectado de la llamada. |
| RestCallTransferAccepted |
Evento aceptado de transferencia de llamada. |
| RestCallTransferFailed |
Evento de error de transferencia de llamadas. |
| RestCancelAddParticipantFailed |
No se pudo cancelar el evento de agregar participante. |
| RestCancelAddParticipantSucceeded |
Cancelación correcta del evento add participant. |
| RestConnectFailed |
Evento ConnectFailed. |
| RestContinuousDtmfRecognitionStopped | |
| RestContinuousDtmfRecognitionToneFailed | |
| RestContinuousDtmfRecognitionToneReceived | |
| RestCreateCallFailed |
Evento de error de creación de la llamada. |
| RestHoldFailed | |
| RestMediaStreamingFailed | |
| RestMediaStreamingStarted | |
| RestMediaStreamingStopped | |
| RestParticipantsUpdated |
Los participantes se actualizaron en un evento de llamada. |
| RestPlayCanceled | |
| RestPlayCompleted | |
| RestPlayFailed | |
| RestPlayStarted |
Evento de inicio de la reproducción. |
| RestRecognizeCanceled | |
| RestRecognizeCompleted | |
| RestRecognizeFailed | |
| RestRecordingStateChanged | |
| RestRemoveParticipantFailed |
No se pudo quitar el evento de participante. |
| RestRemoveParticipantSucceeded |
Evento quitado del participante. |
| RestResultInformation | |
| RestSendDtmfTonesCompleted | |
| RestSendDtmfTonesFailed | |
| RestTranscriptionFailed | |
| RestTranscriptionStarted | |
| RestTranscriptionStopped | |
| RestTranscriptionUpdated | |
| ResultInformation | |
| SendDtmfTonesCompleted |
Evento enviado cuando los tonos dtmf se envían correctamente. |
| SendDtmfTonesFailed |
Evento enviado cuando se produjo un error en el envío de tonos Dtmf. |
| SendDtmfTonesOptions |
Opciones para enviar tonos Dtmf. |
| SendDtmfTonesResult |
Carga de respuesta para enviar tonos DTMF. |
| SipCustomHeader |
Encabezado personalizado SIP. |
| SipUserToUserHeader |
Encabezado Usuario sip a usuario. |
| SpeechResult |
Estado de voz como resultado. |
| SsmlSource |
Modelo SsmlSource. |
| StartMediaStreamingOptions |
Opciones para iniciar la solicitud de streaming multimedia. |
| StartRecordingFailed |
Evento en el que se produjo un error en StartRecording. |
| StartRecordingOptions |
Opciones para iniciar una grabación. |
| StartTranscriptionOptions |
Opciones para iniciar la transcripción |
| StopAudio | |
| StopMediaStreamingOptions |
Opciones para detener la solicitud de streaming multimedia. |
| StopTranscriptionOptions |
Opciones para detener la transcripción |
| TextSource |
El modelo TextSource. |
| TranscriptionData |
Transcripción de streaming. |
| TranscriptionFailed | |
| TranscriptionMetadata |
Metadatos para streaming de transcripción. |
| TranscriptionOptions |
Opciones para la transmisión de medios. |
| TranscriptionStarted | |
| TranscriptionStopped | |
| TranscriptionUpdate | |
| TranscriptionUpdated | |
| TransferCallResult |
Carga de respuesta para transferir la llamada. |
| TransferCallToParticipantOptions |
Opciones para transferir participantes. |
| UnholdOptions |
Opciones para No retener participante. |
| UpdateTranscriptionOptions |
Opciones para actualizar la transcripción |
| VoipHeader |
Encabezado VOIP. |
| WordData |
Texto de la frase. |
Alias de tipos
| AnswerCallResult |
Resultado de AnswerCall |
| AudioFormat |
Define los valores de AudioFormat. Valores conocidos admitidos por el servicio
pcm16KMono |
| CallAutomationEvent |
Eventos de devolución de llamada para Automatización de llamadas |
| CallConnectionStateModel |
Define valores para CallConnectionStateModel. Valores conocidos admitidos por el servicio
desconocido |
| CallLocatorType |
Tipo de localizador de una llamada. |
| CallRejectReason |
Define valores para CallRejectReason. Valores conocidos admitidos por el servicio
ninguno |
| ConnectCallResult |
Resultado de ConnectCall |
| CreateCallResult |
Resultado de CreateCall |
| CustomCallingContext |
Contexto de llamada personalizado |
| DeleteRecordingOptions |
Opciones para eliminar la grabación. |
| GetCallConnectionPropertiesOptions |
Opciones para obtener las propiedades de conexión de llamadas. |
| GetParticipantOptions |
Opciones para obtener un participante. |
| GetRecordingPropertiesOptions |
Opciones para obtener propiedades de grabación. |
| HangUpOptions |
Opciones para colgar la llamada |
| MediaKind |
Tipo de medios de transmisión. |
| MediaStreamingAudioChannelType |
Define valores para MediaStreamingAudioChannelType. Valores conocidos admitidos por el servicio
mixto |
| MediaStreamingContentType |
Define valores para MediaStreamingContentType. Valores conocidos admitidos por el servicioaudio |
| PauseRecordingOptions |
Opciones para obtener una pausa de una grabación. |
| RecognitionType |
Define valores para RecognitionType. Valores conocidos admitidos por el servicio
Dtmf |
| RecordingChannel |
Tipo de canal de una grabación de llamadas. |
| RecordingContent |
Tipo de contenido de una grabación de llamadas. |
| RecordingFormat |
Tipo de formato de una grabación de llamada. |
| RecordingKind |
Tipo de formato de una grabación de llamada. |
| RecordingState |
Define valores para RecordingState. Valores conocidos admitidos por el servicio
activo |
| RecordingStorageKind |
Tipo de almacenamiento de una grabación de llamadas. |
| RedirectCallOptions |
Opciones para redirigir la llamada. |
| ResumeRecordingOptions |
Opciones para reanudar la grabación. |
| SipHeaderPrefix |
El tipo del prefijo de encabezado Sip. |
| StopRecordingOptions |
Opciones para detener una grabación. |
| StreamingDataKind | |
| StreamingDataResult | |
| Tone |
Define los valores de Tone. Valores conocidos admitidos por el servicio
cero |
Enumeraciones
| Channel | |
| DtmfTone |
Un tono Dtmf. |
| KnownCallRejectReason |
Los valores conocidos de CallRejectReason que acepta el servicio. |
| KnownMediaStreamingAudioChannelType |
Valores conocidos de MediaStreamingAudioChannelType que acepta el servicio. |
| KnownMediaStreamingContentType |
Valores conocidos de MediaStreamingContentType que acepta el servicio. |
| KnownStreamingTransportType |
Valores conocidos de KnownStreamingTransportType que acepta el servicio. |
| RecognizeInputType |
Tipo del reconocimiento que acepta el servicio. |
| VoiceKind |
Define los valores de VoiceKind que acepta el servicio. |
Funciones
| create |
Función auxiliar para crear carga útil de datos de audio salientes. |
| create |
Función auxiliar para crear una carga útil de datos de audio de parada saliente. |
| parse |
Función auxiliar para analizar eventos de devolución de llamada de Acs. |
Detalles de la función
createOutboundAudioData(string)
Función auxiliar para crear carga útil de datos de audio salientes.
function createOutboundAudioData(data: string): string
Parámetros
- data
-
string
Devoluciones
string
createOutboundStopAudioData()
Función auxiliar para crear una carga útil de datos de audio de parada saliente.
function createOutboundStopAudioData(): string
Devoluciones
string
parseCallAutomationEvent(string | Record<string, unknown>)
Función auxiliar para analizar eventos de devolución de llamada de Acs.
function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent
Parámetros
- encodedEvents
-
string | Record<string, unknown>