Events and requests for 3P apps
Note
If you are a developer, review how to create applications that react to events: Integrate application with Connect Customer agent workspace agent data.
You must explicitly give third-party applications permission to access Connect Customer data. Assign permissions with the API or in the AWS Management Console. You can also edit the permissions on an existing app.
To understand the effects of assigning a particular permission, review the following permissions, description, and corresponding requests and events.
For example, if you assign User.Details.View to an application, the
application can make the agent.getName and agent.getARN
requests. If your app subscribes to an event or requests data that it doesn't have
permission for, the app might not work as expected.
To learn more about each request and event, see the API Reference.
| Permission | Description | Requests | Events |
|---|---|---|---|
|
User.Details.View |
Details about the agent, such as their full name and user ARN |
agent/getName agent/getARN |
|
|
User.Configuration.View |
Configuration information about the agent, such as their associated routing profile |
agent/getRoutingProfile agent/getChannelConcurrency agent/getExtension getLanguage agent/listAvailabilityStates agent/listQuickConnects voice/getOutboundCallPermission voice/listDialableCountries |
onLanguageChanged |
|
User.Status.View |
Details about the agent's status |
agent/getState |
agent/onStateChanged |
|
Contact.Details.View |
Details about the contact open in the workspace |
contact/getInitialContactId contact/getChannelType contact/getStateDuration contact/getQueue contact/getQueueTimestamp |
contact/onCleared contact/onMissed contact/onStartingAcw contact/onConnected |
|
Contact.CustomerDetails.View |
Details about your customers, such as the phone number they're calling from (Voice only) |
voice/getInitialCustomerPhoneNumber |
|
|
Contact.Attributes.View |
Metadata about the contact |
contact/getAttribute contact/getAttributes |
|
|
User.Status.Edit |
Modify agent status |
agent/setAvailabilityState agent/setAvailabilityStateByName agent/setOffline |
|
|
Contact.Details.Edit |
Contact edit capabilities, such as making outbound calls or transferring calls |
voice/createOutboundCall contact/transfer contact/addParticipant contact/accept contact/clear |
|
|
* |
Provides access to all requests and events. |
