CallConnection class
Класс CallConnection представляет ИНТЕРФЕЙСы API на основе вызовов.
Конструкторы
| Call |
Методы
| add |
Добавление участника в вызов |
| cancel |
Отмена запроса на добавление участника. |
| get |
Получение свойств подключения вызова для вызова |
| get |
Инициализирует новый экземпляр CallMedia. |
| get |
Получение участника из вызова |
| hang |
Повесите звонок для себя или завершите весь звонок. |
| list |
Получение всех участников из вызова |
| mute |
Отключить функцию участника из вызова. |
| remove |
Удаление участника из вызова |
| transfer |
Передача вызова целевому участнику |
Сведения о конструкторе
CallConnection(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)
new CallConnection(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)Параметры
- callConnectionId
-
string
- endpoint
-
string
- credential
- options
-
CallAutomationApiClientOptionalParams
Сведения о методе
addParticipant(CallInvite, AddParticipantOptions)
Добавление участника в вызов
function addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>Параметры
- targetParticipant
- CallInvite
- options
- AddParticipantOptions
Возвращаемое значение
Promise<AddParticipantResult>
cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)
Отмена запроса на добавление участника.
function cancelAddParticipantOperation(invitationId: string, options?: CancelAddParticipantOperationOptions): Promise<CancelAddParticipantOperationResult>Параметры
- invitationId
-
string
Идентификатор приглашения, используемый для отмены запроса на добавление участника.
Возвращаемое значение
Promise<CancelAddParticipantOperationResult>
getCallConnectionProperties(OperationOptions)
Получение свойств подключения вызова для вызова
function getCallConnectionProperties(options?: OperationOptions): Promise<CallConnectionProperties>Параметры
- options
- OperationOptions
Возвращаемое значение
Promise<CallConnectionProperties>
getCallMedia()
Инициализирует новый экземпляр CallMedia.
function getCallMedia(): CallMediaВозвращаемое значение
getParticipant(CommunicationIdentifier, OperationOptions)
Получение участника из вызова
function getParticipant(targetParticipant: CommunicationIdentifier, options?: OperationOptions): Promise<CallParticipant>Параметры
- targetParticipant
- CommunicationIdentifier
Идентификатор связи запрошенного участника.
- options
- OperationOptions
Возвращаемое значение
Promise<CallParticipant>
hangUp(boolean, OperationOptions)
Повесите звонок для себя или завершите весь звонок.
function hangUp(isForEveryone: boolean, options?: OperationOptions): Promise<void>Параметры
- isForEveryone
-
boolean
- options
- OperationOptions
Возвращаемое значение
Promise<void>
listParticipants(OperationOptions)
Получение всех участников из вызова
function listParticipants(options?: OperationOptions): Promise<ListParticipantsResult>Параметры
- options
- OperationOptions
Возвращаемое значение
Promise<ListParticipantsResult>
muteParticipant(CommunicationIdentifier, MuteParticipantOption)
Отключить функцию участника из вызова.
function muteParticipant(participant: CommunicationIdentifier, options?: MuteParticipantOption): Promise<MuteParticipantResult>Параметры
- participant
- CommunicationIdentifier
Участник, отключаемый из вызова.
- options
- MuteParticipantOption
Дополнительные атрибуты для участника отключения звука.
Возвращаемое значение
Promise<MuteParticipantResult>
removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)
Удаление участника из вызова
function removeParticipant(participant: CommunicationIdentifier, options?: RemoveParticipantsOption): Promise<RemoveParticipantResult>Параметры
- participant
- CommunicationIdentifier
Участник будет удален из вызова.
- options
- RemoveParticipantsOption
Возвращаемое значение
Promise<RemoveParticipantResult>
transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)
Передача вызова целевому участнику
function transferCallToParticipant(targetParticipant: CommunicationIdentifier, options?: TransferCallToParticipantOptions): Promise<TransferCallResult>Параметры
- targetParticipant
- CommunicationIdentifier
Целевой объект, в который необходимо передать.
- options
- TransferCallToParticipantOptions
Возвращаемое значение
Promise<TransferCallResult>