Amazon Connect Agent Workspace Voice API - Agent Workspace

Amazon Connect Agent Workspace Voice API

The Amazon Connect SDK provides an VoiceClient which serves as an interface that your app in the Amazon Connect agent workspace can use to make data requests on voice contact.

The VoiceClient accepts an optional constructor argument, ConnectClientConfig which itself is defined as:


export type ConnectClientConfig = {  
    context?: ModuleContext;  
    provider?: AmazonConnectProvider;
};

If you do not provide a value for this config, then the client will default to using the AmazonConnectProvider set in the global provider scope. You can also manually configure this using setGlobalProvider.

You can instantiate the agent client as follows:


import { VoiceClient } from "@amazon-connect/voice";

const voiceClient = new VoiceClient({ provider });
Note

You must first instantiate the AmazonConnectApp which initializes the default AmazonConnectProvider and returns { provider } . This is the recommended option.

Alternatively, providing a constructor argument:


import { VoiceClient } from "@amazon-connect/voice";
            
const voiceClient = new VoiceClient({
    context: sampleContext,  
    provider: sampleProvider
});
Note

Third-party applications must be configured with * permission in order to utilize the VoiceClient APIs.

The following sections describe API calls for working with the Voice API.

Contents