@azure/communication-call-automation package

Classes

CallAutomationClient

Um CallAutomationClient representa um Client para o serviço Azure Communication CallAutomation.

CallConnection

A classe CallConnection representa APIs baseadas em conexão de chamada.

CallMedia

A classe CallMedia representa APIs relacionadas à mídia de chamada.

CallRecording

A classe CallRecording representa APIs relacionadas à gravação de chamadas.

StreamingData

Classe para lidar com a análise de dados de streaming de entrada.

Interfaces

AddParticipantFailed

O evento de participante falhou ao adicionar.

AddParticipantOptions

Opções para adicionar participantes.

AddParticipantResult

A carga útil de resposta para adicionar participantes à chamada.

AddParticipantSucceeded

O participante adicionou o evento com sucesso.

AnswerCallOptions

Opções para atender uma chamada.

AnswerFailed
AudioData

Dados de streaming de áudio.

AudioMetadata

Metadados de streaming de áudio.

CallAutomationClientOptions

Opções de cliente usadas para configurar solicitações de API do cliente CallAutomation.

CallConnected

Evento quando a chamada foi estabelecida.

CallConnectionProperties

Propriedades de uma conexão de chamada

CallDisconnected

Evento quando todos os participantes saíram e a chamada foi encerrada.

CallIntelligenceOptions

Opções de IA para a chamada.

CallInvite

Ligue para os detalhes do convidado.

CallLocator

O localizador usado para ingressar ou executar ações em uma chamada.

CallMediaRecognizeChoiceOptions

A configuração de reconhecimento específica para Opções.

CallMediaRecognizeDtmfOptions

A configuração de reconhecimento específica para Dtmf.

CallMediaRecognizeOptions

Opções para configurar a operação de reconhecimento.

CallMediaRecognizeSpeechOptions

A configuração de reconhecimento específica para Fala.

CallMediaRecognizeSpeechOrDtmfOptions

A configuração de reconhecimento para Speech ou Dtmf

CallParticipant

Modelo de contrato de um participante na chamada ACS

CallResult

A interface usada como pai de [action]CallResult

CallTransferAccepted

Evento em que a solicitação de transferência foi bem-sucedida.

CallTransferFailed

Evento em que a solicitação de transferência falhou.

CancelAddParticipantFailed

Falha ao cancelar adicionar evento de participante.

CancelAddParticipantOperationOptions

Opções para cancelar adicionar solicitação de participante.

CancelAddParticipantOperationResult

A carga útil de resposta para cancelar adicionar solicitação de participante.

CancelAddParticipantSucceeded

Cancelamento bem-sucedido adicionar evento de participante.

ChannelAffinity

Afinidade de canal para um participante

ChoiceResult
ConnectCallOptions

Opções para solicitação de conexão.

ConnectFailed
ContinuousDtmfRecognitionOptions

Opções para reconhecimento contínuo de Dtmf.

ContinuousDtmfRecognitionStopped

Evento enviado quando o reconhecimento contínuo de Dtmf parou.

ContinuousDtmfRecognitionToneFailed

Evento enviado quando não foi possível reconhecer o tom Dtmf contínuo.

ContinuousDtmfRecognitionToneReceived

Evento enviado quando o tom Dtmf foi recebido do participante alvo na chamada.

CreateCallFailed
CreateCallOptions

Opções para criar uma chamada.

DownloadRecordingOptions

Opções para baixar a gravação.

DtmfData

Dados de streaming Dtmf.

DtmfResult
FileSource

O modelo FileSource.

HoldFailed
HoldOptions

Opções para segurar participante.

ListParticipantsResult

A carga útil de resposta para obter participantes da chamada.

MediaStreamingFailed
MediaStreamingOptions

Opções para streaming de mídia.

MediaStreamingStarted
MediaStreamingStopped
MediaStreamingUpdate
MuteParticipantOption

Opções para silenciar o participante.

MuteParticipantResult

A carga útil de resposta para silenciar o participante da chamada.

OutStreamingData

Interface OutboundStreamingAudioData para carga útil de streaming de áudio de saída.

ParticipantsUpdated

Evento em que houve uma atualização do(s) participante(s).

PlayCanceled

Evento em que a reprodução de mídia foi cancelada pela operação Cancelar.

PlayCompleted

Evento em que a reprodução de mídia foi concluída com êxito.

PlayFailed

Evento em que a reprodução de mídia falhou.

PlayOptions

Opções para reproduzir áudio.

PlaySource

O modelo PlaySource.

PlayStarted

Evento em que a reprodução de mídia foi iniciada com êxito.

PlayToAllOptions

Opções para reproduzir áudio ToAll.

RecognitionChoice

Uma escolha de reconhecimento

RecognizeCanceled

Evento em que o reconhecimento de mídia foi cancelado pela operação Cancelar.

RecognizeCompleted

Evento em que o reconhecimento de mídia foi concluído com êxito.

RecognizeFailed

Evento em que o reconhecimento de mídia falhou.

RecordingStateChanged

Evento quando o estado de gravação foi alterado.

RecordingStateResult

A carga útil de resposta para iniciar uma gravação de chamada ou obter o estado de gravação de chamadas.

RecordingStorage

O armazenamento de gravação

RejectCallOptions

Opções para rejeitar chamada.

RemoveParticipantFailed

O evento de participante falhou ao remover.

RemoveParticipantResult

A carga útil de resposta para remover participantes da chamada.

RemoveParticipantSucceeded

O participante removeu o evento com sucesso.

RemoveParticipantsOption

Opções para remover participantes.

RestAddParticipantFailed

O evento Falha ao adicionar participantes.

RestAddParticipantSucceeded

Os participantes adicionaram o evento com sucesso.

RestAnswerFailed

O evento de chamada falhou ao responder.

RestCallConnected

O evento call connected.

RestCallDisconnected

O evento de chamada desconectado.

RestCallTransferAccepted

O evento de transferência de chamada aceito.

RestCallTransferFailed

O evento de falha na transferência de chamada.

RestCancelAddParticipantFailed

Falha ao cancelar adicionar evento de participante.

RestCancelAddParticipantSucceeded

Cancelamento bem-sucedido adicionar evento de participante.

RestConnectFailed

O evento ConnectFailed.

RestContinuousDtmfRecognitionStopped
RestContinuousDtmfRecognitionToneFailed
RestContinuousDtmfRecognitionToneReceived
RestCreateCallFailed

O evento de falha de chamada de criação.

RestHoldFailed
RestMediaStreamingFailed
RestMediaStreamingStarted
RestMediaStreamingStopped
RestParticipantsUpdated

Os participantes foram atualizados em um evento de chamada.

RestPlayCanceled
RestPlayCompleted
RestPlayFailed
RestPlayStarted

Evento iniciado do jogo.

RestRecognizeCanceled
RestRecognizeCompleted
RestRecognizeFailed
RestRecordingStateChanged
RestRemoveParticipantFailed

O evento de participante falhou ao remover.

RestRemoveParticipantSucceeded

O participante removeu o evento.

RestResultInformation
RestSendDtmfTonesCompleted
RestSendDtmfTonesFailed
RestTranscriptionFailed
RestTranscriptionStarted
RestTranscriptionStopped
RestTranscriptionUpdated
ResultInformation
SendDtmfTonesCompleted

Evento enviado quando os tons Dtmf são enviados com êxito.

SendDtmfTonesFailed

Evento enviado quando o envio de tons Dtmf falhou.

SendDtmfTonesOptions

Opções para enviar tons Dtmf.

SendDtmfTonesResult

A carga útil de resposta para enviar tons DTMF.

SipCustomHeader

Cabeçalho personalizado SIP.

SipUserToUserHeader

Cabeçalho SIP Usuário Para Usuário.

SpeechResult

O status da fala como resultado.

SsmlSource

O modelo SsmlSource.

StartMediaStreamingOptions

Opções para iniciar a solicitação de streaming de mídia.

StartRecordingFailed

Evento em que StartRecording falhou.

StartRecordingOptions

Opções para iniciar uma gravação.

StartTranscriptionOptions

Opções para iniciar a transcrição

StopAudio
StopMediaStreamingOptions

Opções para parar a solicitação de streaming de mídia.

StopTranscriptionOptions

Opções para interromper a transcrição

TextSource

O modelo TextSource.

TranscriptionData

Transcrição de streaming.

TranscriptionFailed
TranscriptionMetadata

Metadados para streaming de transcrição.

TranscriptionOptions

Opções para streaming de mídia.

TranscriptionStarted
TranscriptionStopped
TranscriptionUpdate
TranscriptionUpdated
TransferCallResult

A carga útil de resposta para transferir a chamada.

TransferCallToParticipantOptions

Opções para transferir participantes.

UnholdOptions

Opções para não segurar participante.

UpdateTranscriptionOptions

Opções para atualizar a transcrição

VoipHeader

Cabeçalho VOIP.

WordData

Texto na frase.

Aliases de Tipo

AnswerCallResult

Resultado do AnswerCall

AudioFormat

Define valores para AudioFormat.
<xref:KnownAudioFormat> pode ser usado de forma intercambiável com AudioFormat, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

pcm16KMono
pcm24KMono

CallAutomationEvent

Eventos de retorno de chamada para automação de chamadas

CallConnectionStateModel

Define valores para CallConnectionStateModel.
<xref:KnownCallConnectionStateModel> pode ser usado de forma intercambiável com CallConnectionStateModel, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

desconhecido
conectando
conectado
transferência de
transferênciaAceito
desconectar
desconectado

CallLocatorType

O tipo de localizador de uma chamada.

CallRejectReason

Define valores para CallRejectReason.
KnownCallRejectReason pode ser usado de forma intercambiável com CallRejectReason, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

nenhuma
ocupado
proibido

ConnectCallResult

Resultado do ConnectCall

CreateCallResult

Resultado CreateCall

CustomCallingContext

Contexto de chamada personalizado

DeleteRecordingOptions

Opções para excluir a gravação.

GetCallConnectionPropertiesOptions

Opções para obter propriedades de conexão de chamada.

GetParticipantOptions

Opções para conseguir um participante.

GetRecordingPropertiesOptions

Opções para obter propriedades de gravação.

HangUpOptions

Opções para desligar a chamada

MediaKind

Tipo de streaming de mídia.

MediaStreamingAudioChannelType

Define valores para MediaStreamingAudioChannelType.
KnownMediaStreamingAudioChannelType pode ser usado de forma intercambiável com MediaStreamingAudioChannelType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

misto
não misturado

MediaStreamingContentType

Define valores para MediaStreamingContentType.
KnownMediaStreamingContentType pode ser usado de forma intercambiável com MediaStreamingContentType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

áudio

PauseRecordingOptions

Opções para pausar uma gravação.

RecognitionType

Define valores para RecognitionType.
<xref:KnownRecognitionType> pode ser usado de forma intercambiável com RecognitionType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

DTMF
discurso
escolhas

RecordingChannel

O tipo de canal de uma gravação de chamada.

RecordingContent

O tipo de conteúdo de uma gravação de chamada.

RecordingFormat

O tipo de formato de uma gravação de chamada.

RecordingKind

O tipo de formato de uma gravação de chamada.

RecordingState

Define valores para RecordingState.
<xref:KnownRecordingState> pode ser usado de forma intercambiável com RecordingState, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ativa
inativo

RecordingStorageKind

O tipo de armazenamento de uma gravação de chamadas.

RedirectCallOptions

Opções para redirecionar chamada.

ResumeRecordingOptions

Opções para retomar a gravação.

SipHeaderPrefix

O tipo do prefixo do cabeçalho Sip.

StopRecordingOptions

Opções para parar uma gravação.

StreamingDataKind
StreamingDataResult
Tone

Define valores para Tone.
<xref:KnownTone> pode ser usado de forma intercambiável com o Tone, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

zero
um
dois
três
quatro
cinco
seis
sete
oito
nove
um
b
c
d
libra
asterisco

Enumerações

Channel
DtmfTone

Um tom Dtmf.

KnownCallRejectReason

Os valores conhecidos de CallRejectReason que o serviço aceita.

KnownMediaStreamingAudioChannelType

Valores conhecidos de MediaStreamingAudioChannelType que o serviço aceita.

KnownMediaStreamingContentType

Valores conhecidos de MediaStreamingContentType que o serviço aceita.

KnownStreamingTransportType

Valores conhecidos de KnownStreamingTransportType que o serviço aceita.

RecognizeInputType

O tipo de reconhecimento que o serviço aceita.

VoiceKind

Define valores para VoiceKind que o serviço aceita.

Funções

createOutboundAudioData(string)

Função auxiliar para criar carga útil de dados de áudio de saída.

createOutboundStopAudioData()

Função auxiliar para criar carga útil de dados de áudio de parada de saída.

parseCallAutomationEvent(string | Record<string, unknown>)

Função auxiliar para analisar eventos de retorno de chamada do Acs.

Detalhes de Função

createOutboundAudioData(string)

Função auxiliar para criar carga útil de dados de áudio de saída.

function createOutboundAudioData(data: string): string

Parâmetros

data

string

Devoluções

string

createOutboundStopAudioData()

Função auxiliar para criar carga útil de dados de áudio de parada de saída.

function createOutboundStopAudioData(): string

Devoluções

string

parseCallAutomationEvent(string | Record<string, unknown>)

Função auxiliar para analisar eventos de retorno de chamada do Acs.

function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent

Parâmetros

encodedEvents

string | Record<string, unknown>

Devoluções