@azure/communication-call-automation package
Классы
| CallAutomationClient |
CallAutomationClient представляет клиент в службу ВызоваAutomation Azure. |
| CallConnection |
Класс CallConnection представляет ИНТЕРФЕЙСы API на основе вызовов. |
| CallMedia |
Класс CallMedia представляет интерфейсы API, связанные с носителями вызовов. |
| CallRecording |
Класс CallRecording представляет связанные API-интерфейсы записи вызовов. |
| StreamingData |
Класс для обработки анализа входящих потоковых данных. |
Интерфейсы
| AddParticipantFailed |
Не удалось добавить событие участника. |
| AddParticipantOptions |
Параметры добавления участников. |
| AddParticipantResult |
Полезные данные ответа для добавления участников в вызов. |
| AddParticipantSucceeded |
Участник успешно добавил событие. |
| AnswerCallOptions |
Параметры ответа на звонок. |
| AnswerFailed | |
| AudioData |
Данные потоковой передачи звука. |
| AudioMetadata |
Метаданные потоковой передачи звука. |
| CallAutomationClientOptions |
Параметры клиента, используемые для настройки запросов API клиента CallAutomation. |
| CallConnected |
Событие при установке вызова. |
| CallConnectionProperties |
Свойства подключения к вызову |
| CallDisconnected |
Событие, когда все участники покинули и завершили вызов. |
| CallIntelligenceOptions |
Параметры искусственного интеллекта для вызова. |
| CallInvite |
Вызов сведений о приглашении. |
| CallLocator |
Указатель, используемый для присоединения или принятия действий по вызову. |
| CallMediaRecognizeChoiceOptions |
Конфигурация распознавания, зависят от вариантов. |
| CallMediaRecognizeDtmfOptions |
Конфигурация распознавания, зависят от Dtmf. |
| CallMediaRecognizeOptions |
Параметры настройки операции распознавания. |
| CallMediaRecognizeSpeechOptions |
Конфигурация распознавания, зависят от службы "Речь". |
| CallMediaRecognizeSpeechOrDtmfOptions |
Конфигурация распознавания речи или Dtmf |
| CallParticipant |
Модель контракта участника вызова ACS |
| CallResult |
Интерфейс, используемый в качестве родительского для [action]CallResult |
| CallTransferAccepted |
Событие при успешном выполнении запроса на передачу. |
| CallTransferFailed |
Событие при сбое запроса на передачу. |
| CancelAddParticipantFailed |
Не удалось отменить событие добавления участника. |
| CancelAddParticipantOperationOptions |
Параметры отмены запроса на добавление участника. |
| CancelAddParticipantOperationResult |
Полезные данные ответа для отмены запроса участника. |
| CancelAddParticipantSucceeded |
Успешное отмена добавления события участника. |
| ChannelAffinity |
Сходство каналов для участника |
| ChoiceResult | |
| ConnectCallOptions |
Параметры для подключения запроса. |
| ConnectFailed | |
| ContinuousDtmfRecognitionOptions |
Параметры непрерывного распознавания Dtmf. |
| ContinuousDtmfRecognitionStopped |
Событие, отправленное при остановке непрерывного распознавания Dtmf. |
| ContinuousDtmfRecognitionToneFailed |
Событие, отправленное, когда не удалось распознать непрерывный тон Dtmf. |
| ContinuousDtmfRecognitionToneReceived |
Событие, отправленное при получении от целевого участника в вызове тон Dtmf. |
| CreateCallFailed | |
| CreateCallOptions |
Параметры для создания вызова. |
| DownloadRecordingOptions |
Параметры скачивания записи. |
| DtmfData |
Потоковые данные Dtmf. |
| DtmfResult | |
| FileSource |
Модель FileSource. |
| HoldFailed | |
| HoldOptions |
Параметры для удержания участника. |
| ListParticipantsResult |
Полезные данные ответа для получения участников вызова. |
| MediaStreamingFailed | |
| MediaStreamingOptions |
Варианты потоковой передачи мультимедиа. |
| MediaStreamingStarted | |
| MediaStreamingStopped | |
| MediaStreamingUpdate | |
| MuteParticipantOption |
Параметры для отключения функции участника. |
| MuteParticipantResult |
Полезные данные ответа для выключения участника из вызова. |
| OutStreamingData |
Интерфейс OutboundStreamingAudioData для полезной нагрузки потоковой передачи исходящего звука. |
| ParticipantsUpdated |
Событие, когда произошло обновление участников. |
| PlayCanceled |
Событие, когда воспроизведение мультимедиа было отменено операцией отмены. |
| PlayCompleted |
Событие, когда воспроизведение мультимедиа успешно завершено. |
| PlayFailed |
Событие, когда произошел сбой воспроизведения мультимедиа. |
| PlayOptions |
Параметры воспроизведения звука. |
| PlaySource |
Модель PlaySource. |
| PlayStarted |
Событие, когда воспроизведение мультимедиа успешно запущено. |
| PlayToAllOptions |
Параметры воспроизведения звукаToAll. |
| RecognitionChoice |
Выбор распознавания |
| RecognizeCanceled |
Событие, когда распознавание мультимедиа было отменено операцией Отмены. |
| RecognizeCompleted |
Событие при успешном завершении распознавания мультимедиа. |
| RecognizeFailed |
Событие, когда не удалось распознать носитель. |
| RecordingStateChanged |
Событие при изменении состояния записи. |
| RecordingStateResult |
Полезные данные ответа для запуска записи звонка или получения состояния записи звонка. |
| RecordingStorage |
Хранилище записей |
| RejectCallOptions |
Параметры для отклонения вызова. |
| RemoveParticipantFailed |
Не удалось удалить событие участника. |
| RemoveParticipantResult |
Полезные данные ответа для удаления участников из вызова. |
| RemoveParticipantSucceeded |
Участник успешно удалил событие. |
| RemoveParticipantsOption |
Параметры удаления участников. |
| RestAddParticipantFailed |
Не удалось добавить событие участников. |
| RestAddParticipantSucceeded |
Участники успешно добавили событие. |
| RestAnswerFailed |
Не удалось ответить на событие вызова. |
| RestCallConnected |
Событие подключения вызова. |
| RestCallDisconnected |
Событие отключения вызова. |
| RestCallTransferAccepted |
Принятое событие передачи вызовов. |
| RestCallTransferFailed |
Сбой передачи вызовов. |
| RestCancelAddParticipantFailed |
Сбой отмены добавления события участника. |
| RestCancelAddParticipantSucceeded |
Успешное отмена добавления события участника. |
| RestConnectFailed |
Событие ConnectFailed. |
| RestContinuousDtmfRecognitionStopped | |
| RestContinuousDtmfRecognitionToneFailed | |
| RestContinuousDtmfRecognitionToneReceived | |
| RestCreateCallFailed |
Событие создания вызова завершилось сбоем. |
| RestHoldFailed | |
| RestMediaStreamingFailed | |
| RestMediaStreamingStarted | |
| RestMediaStreamingStopped | |
| RestParticipantsUpdated |
Участники обновили событие вызова. |
| RestPlayCanceled | |
| RestPlayCompleted | |
| RestPlayFailed | |
| RestPlayStarted |
Воспроизведение запущенного события. |
| RestRecognizeCanceled | |
| RestRecognizeCompleted | |
| RestRecognizeFailed | |
| RestRecordingStateChanged | |
| RestRemoveParticipantFailed |
Не удалось удалить событие участника. |
| RestRemoveParticipantSucceeded |
Участник удалил событие. |
| RestResultInformation | |
| RestSendDtmfTonesCompleted | |
| RestSendDtmfTonesFailed | |
| RestTranscriptionFailed | |
| RestTranscriptionStarted | |
| RestTranscriptionStopped | |
| RestTranscriptionUpdated | |
| ResultInformation | |
| SendDtmfTonesCompleted |
Событие, отправленное при успешной отправке тонов Dtmf. |
| SendDtmfTonesFailed |
Событие, отправленное при сбое отправки тонов Dtmf. |
| SendDtmfTonesOptions |
Параметры отправки тонов Dtmf. |
| SendDtmfTonesResult |
Полезные данные ответа для отправки тонов DTMF. |
| SipCustomHeader |
Пользовательский заголовок SIP. |
| SipUserToUserHeader |
Заголовок SIP-пользователя к пользователю. |
| SpeechResult |
В результате состояние речи. |
| SsmlSource |
Модель SsmlSource. |
| StartMediaStreamingOptions |
Параметры запуска запроса потоковой передачи мультимедиа. |
| StartRecordingFailed |
Событие, когда не удалось выполнить StartRecording. |
| StartRecordingOptions |
Параметры получения записи. |
| StartTranscriptionOptions |
Параметры запуска транскрибирования |
| StopAudio | |
| StopMediaStreamingOptions |
Параметры для остановки запроса потоковой передачи мультимедиа. |
| StopTranscriptionOptions |
Параметры остановки транскрибирования |
| TextSource |
Модель TextSource. |
| TranscriptionData |
Потоковая транскрибирование. |
| TranscriptionFailed | |
| TranscriptionMetadata |
Метаданные потоковой передачи транскрибирования. |
| TranscriptionOptions |
Варианты потоковой передачи мультимедиа. |
| TranscriptionStarted | |
| TranscriptionStopped | |
| TranscriptionUpdate | |
| TranscriptionUpdated | |
| TransferCallResult |
Полезные данные ответа для передачи вызова. |
| TransferCallToParticipantOptions |
Параметры передачи участников. |
| UnholdOptions |
Параметры для отмены удержания участника. |
| UpdateTranscriptionOptions |
Параметры обновления транскрибирования |
| VoipHeader |
Заголовок VOIP. |
| WordData |
Текст в фразе. |
Псевдонимы типа
| AnswerCallResult |
Результат AnswerCall |
| AudioFormat |
Определяет значения для AudioFormat. Известные значения, поддерживаемые службой
pcm16KMono |
| CallAutomationEvent |
События обратного вызова для автоматизации вызовов |
| CallConnectionStateModel |
Определяет значения для CallConnectionStateModel. Известные значения, поддерживаемые службойнеизвестный |
| CallLocatorType |
Тип указателя вызова. |
| CallRejectReason |
Определяет значения для CallRejectReason. Известные значения, поддерживаемые службой
нет |
| ConnectCallResult |
Результат ConnectCall |
| CreateCallResult |
Результат CreateCall |
| CustomCallingContext |
Контекст пользовательского вызова |
| DeleteRecordingOptions |
Параметры удаления записи. |
| GetCallConnectionPropertiesOptions |
Параметры для получения свойств подключения вызова. |
| GetParticipantOptions |
Параметры получения участника. |
| GetRecordingPropertiesOptions |
Параметры получения свойств записи. |
| HangUpOptions |
Параметры повесить звонок |
| MediaKind |
Вид потокового мультимедиа. |
| MediaStreamingAudioChannelType |
Определяет значения для MediaStreamingAudioChannelType. Известные значения, поддерживаемые службой
смешанный |
| MediaStreamingContentType |
Определяет значения для MediaStreamingContentType. Известные значения, поддерживаемые службойаудио |
| PauseRecordingOptions |
Параметры для приостановки записи. |
| RecognitionType |
Определяет значения для RecognitionType. Известные значения, поддерживаемые службой
dtmf |
| RecordingChannel |
Тип канала записи вызовов. |
| RecordingContent |
Тип контента записи вызова. |
| RecordingFormat |
Тип формата записи вызова. |
| RecordingKind |
Тип формата записи вызова. |
| RecordingState |
Определяет значения для RecordingState. Известные значения, поддерживаемые службойактивные |
| RecordingStorageKind |
Тип хранилища записи вызовов. |
| RedirectCallOptions |
Параметры перенаправления вызова. |
| ResumeRecordingOptions |
Параметры возобновления записи. |
| SipHeaderPrefix |
Тип префикса заголовка Sip. |
| StopRecordingOptions |
Параметры для получения остановки записи. |
| StreamingDataKind | |
| StreamingDataResult | |
| Tone |
Определяет значения для тона. Известные значения, поддерживаемые службой
ноль |
Перечисления
| Channel | |
| DtmfTone |
Тон Dtmf. |
| KnownCallRejectReason |
Известные значения CallRejectReason, которые служба принимает. |
| KnownMediaStreamingAudioChannelType |
Известные значения MediaStreamingAudioChannelType , которые принимает служба. |
| KnownMediaStreamingContentType |
Известные значения MediaStreamingContentType , которые принимает служба. |
| KnownStreamingTransportType |
Известные значения KnownStreamingTransportType, которые принимает служба. |
| RecognizeInputType |
Тип распознавания, которое принимает служба. |
| VoiceKind |
Определяет значения VoiceKind, которые служба принимает. |
Функции
| create |
Вспомогательная функция для создания полезной нагрузки исходящих аудиоданных. |
| create |
Вспомогательная функция для создания полезной нагрузки исходящих аудиоданных остановки. |
| parse |
Вспомогательные функции для синтаксического анализа событий обратного вызова Acs. |
Сведения о функции
createOutboundAudioData(string)
Вспомогательная функция для создания полезной нагрузки исходящих аудиоданных.
function createOutboundAudioData(data: string): string
Параметры
- data
-
string
Возвращаемое значение
string
createOutboundStopAudioData()
Вспомогательная функция для создания полезной нагрузки исходящих аудиоданных остановки.
function createOutboundStopAudioData(): string
Возвращаемое значение
string
parseCallAutomationEvent(string | Record<string, unknown>)
Вспомогательные функции для синтаксического анализа событий обратного вызова Acs.
function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent
Параметры
- encodedEvents
-
string | Record<string, unknown>