com.azure.communication.callautomation.CallAutomationClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-communication-callautomation Show documentation
This package contains clients and data structures used to make call with Azure Communication Call Automation Service. For this release, see notes - https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-callautomation/README.md and https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-callautomation/CHANGELOG.md.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.communication.callautomation;

import com.azure.communication.callautomation.models.AnswerCallOptions;
import com.azure.communication.callautomation.models.AnswerCallResult;
import com.azure.communication.callautomation.models.CallInvite;
import com.azure.communication.callautomation.models.CreateCallOptions;
import com.azure.communication.callautomation.models.CreateGroupCallOptions;
import com.azure.communication.callautomation.models.CreateCallResult;
import com.azure.communication.callautomation.models.RedirectCallOptions;
import com.azure.communication.callautomation.models.RejectCallOptions;
import com.azure.communication.callautomation.models.ConnectCallOptions;
import com.azure.communication.callautomation.models.ConnectCallResult;
import com.azure.communication.callautomation.models.CallLocator;
import com.azure.communication.common.CommunicationIdentifier;
import com.azure.communication.common.CommunicationUserIdentifier;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceClient;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.core.exception.HttpResponseException;

import java.util.List;

/**
 * Synchronous client that supports calling server operations.
 *
 * Instantiating a synchronous Calling Server Client
 *
 * View {@link CallAutomationClientBuilder this} for additional ways to construct the client.
 *
 * @see CallAutomationClientBuilder
 */
@ServiceClient(builder = CallAutomationClientBuilder.class)
public final class CallAutomationClient {
    private final CallAutomationAsyncClient callAutomationAsyncClient;

    CallAutomationClient(CallAutomationAsyncClient callAutomationAsyncClient) {
        this.callAutomationAsyncClient = callAutomationAsyncClient;
    }

    /**
     * Get Source Identity that is used for create and answer call
     * @return {@link CommunicationUserIdentifier} represent source
     */
    public CommunicationUserIdentifier getSourceIdentity() {
        return callAutomationAsyncClient.getSourceIdentity();
    }

    //region Pre-call Actions
    /**
     * Create a call connection request from a source identity to a target identity.
     *
     * @param targetParticipant call invitee's information
     * @param callbackUrl The call back url for receiving events.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Result of creating the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public CreateCallResult createCall(CallInvite targetParticipant, String callbackUrl) {
        return callAutomationAsyncClient.createCall(targetParticipant, callbackUrl).block();
    }

    /**
     * Create a call connection request from a source identity to a list of target identity.
     *
     * @param targetParticipants The list of targetParticipants.
     * @param callbackUrl The call back url for receiving events.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Result of creating the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public CreateCallResult createGroupCall(List targetParticipants, String callbackUrl) {
        return callAutomationAsyncClient.createGroupCall(targetParticipants, callbackUrl).block();
    }

    /**
     * Create a call connection request from a source identity to a target identity.
     *
     * @param createCallOptions Options bag for creating a new call.
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with result of creating the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response createCallWithResponse(CreateCallOptions createCallOptions, Context context) {
        return callAutomationAsyncClient.createCallWithResponseInternal(createCallOptions, context).block();
    }

    /**
     * Create a group call connection request from a source identity to multiple identities.
     *
     * @param createGroupCallOptions Options bag for creating a new group call.
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with result of creating the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response createGroupCallWithResponse(CreateGroupCallOptions createGroupCallOptions,
        Context context) {
        return callAutomationAsyncClient.createGroupCallWithResponseInternal(createGroupCallOptions, context).block();
    }

    /**
     * Answer an incoming call
     *
     * @param incomingCallContext The incoming call context.
     * @param callbackUrl The call back url.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Result of answering the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public AnswerCallResult answerCall(String incomingCallContext, String callbackUrl) {
        return callAutomationAsyncClient.answerCall(incomingCallContext, callbackUrl).block();
    }

    /**
     * Create a call connection request from a source identity to a target identity.
     *
     * @param answerCallOptions The options of answering the call.
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with result of answering the call.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response answerCallWithResponse(AnswerCallOptions answerCallOptions, Context context) {
        return callAutomationAsyncClient.answerCallWithResponseInternal(answerCallOptions, context).block();
    }

    /**
     * Redirect a call
     *
     * @param incomingCallContext The incoming call context.
     * @param targetParticipant {@link CallInvite} represent redirect targetParticipant
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public void redirectCall(String incomingCallContext, CallInvite targetParticipant) {
        callAutomationAsyncClient.redirectCall(incomingCallContext, targetParticipant).block();
    }

    /**
     * Redirect a call
     *
     * @param redirectCallOptions options of redirecting a call
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with Void.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response redirectCallWithResponse(RedirectCallOptions redirectCallOptions, Context context) {
        return callAutomationAsyncClient.redirectCallWithResponseInternal(redirectCallOptions, context).block();
    }

    /**
     * Reject a call
     *
     * @param incomingCallContext The incoming call context.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public void rejectCall(String incomingCallContext) {
        callAutomationAsyncClient.rejectCall(incomingCallContext).block();
    }

    /**
     * Reject a call
     *
     * @param rejectCallOptions The options of rejecting the call.
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with Void.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response rejectCallWithResponse(RejectCallOptions rejectCallOptions, Context context) {
        return callAutomationAsyncClient.rejectCallWithResponseInternal(rejectCallOptions, context).block();
    }

    /**
    * Create a connect request
    *
    * @param callLocator call locator.
    * @param callbackUrl The call back url for receiving events.
    * @throws HttpResponseException thrown if the request is rejected by server.
    * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
    * @return Result of connect.
    */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public ConnectCallResult connectCall(CallLocator callLocator, String callbackUrl) {
        return callAutomationAsyncClient.connectCall(callLocator, callbackUrl).block();
    }

    /**
     * Create a connect request.
     *
     * @param connectCallOptions Options for connect request.
     * @param context The context to associate with this operation.
     * @throws HttpResponseException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return Response with result of connect.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public Response connectCallWithResponse(ConnectCallOptions connectCallOptions, Context context) {
        return callAutomationAsyncClient.connectCallWithResponseInternal(connectCallOptions, context).block();
    }
    //endregion

    //region Mid-call Actions
    /***
     * Returns an object of CallConnection
     *
     * @param callConnectionId the id of the call connection
     * @return a CallConnection.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public CallConnection getCallConnection(String callConnectionId) {
        return new CallConnection(callAutomationAsyncClient.getCallConnectionAsync(callConnectionId));
    }
    //endregion

    //region Content Management actions
    /***
     * Returns an object of CallRecording
     *
     * @return a CallRecording.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    public CallRecording getCallRecording() {
        return new CallRecording(callAutomationAsyncClient.getCallRecordingAsync());
    }
    //endregion
}