Expand description
Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
If you’re using the service, you’re probably looking for AlexaForBusinessClient and AlexaForBusiness.
Structs§
- Address
Book An address book with attributes.
- Address
Book Data Information related to an address book.
- Alexa
ForBusiness Client - A client for the Alexa For Business API.
- Approve
Skill Request - Approve
Skill Response - Associate
Contact With Address Book Request - Associate
Contact With Address Book Response - Associate
Device With Network Profile Request - Associate
Device With Network Profile Response - Associate
Device With Room Request - Associate
Device With Room Response - Associate
Skill Group With Room Request - Associate
Skill Group With Room Response - Associate
Skill With Skill Group Request - Associate
Skill With Skill Group Response - Associate
Skill With Users Request - Associate
Skill With Users Response - Audio
The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,
required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:
ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>- Business
Report Usage report with specified parameters.
- Business
Report Content Range The content range of the report.
- Business
Report Recurrence The recurrence of the reports.
- Business
Report S3Location The S3 location of the output reports.
- Business
Report Schedule The schedule of the usage report.
- Category
The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.
- Conference
Preference The default conference provider that is used if no other scheduled meetings are detected.
- Conference
Provider An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.
- Contact
A contact with attributes.
- Contact
Data Information related to a contact.
- Content
The content definition. This can contain only one text, SSML, or audio list object.
- Create
Address Book Request - Create
Address Book Response - Create
Business Report Schedule Request - Create
Business Report Schedule Response - Create
Conference Provider Request - Create
Conference Provider Response - Create
Contact Request - Create
Contact Response - Create
EndOf Meeting Reminder Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- Create
Gateway Group Request - Create
Gateway Group Response - Create
Instant Booking Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
- Create
Meeting Room Configuration Creates meeting room settings of a room profile.
- Create
Network Profile Request - Create
Network Profile Response - Create
Profile Request - Create
Profile Response - Create
Require Check In Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
- Create
Room Request - Create
Room Response - Create
Skill Group Request - Create
Skill Group Response - Create
User Request - Create
User Response - Delete
Address Book Request - Delete
Address Book Response - Delete
Business Report Schedule Request - Delete
Business Report Schedule Response - Delete
Conference Provider Request - Delete
Conference Provider Response - Delete
Contact Request - Delete
Contact Response - Delete
Device Request - Delete
Device Response - Delete
Device Usage Data Request - Delete
Device Usage Data Response - Delete
Gateway Group Request - Delete
Gateway Group Response - Delete
Network Profile Request - Delete
Network Profile Response - Delete
Profile Request - Delete
Profile Response - Delete
Room Request - Delete
Room Response - Delete
Room Skill Parameter Request - Delete
Room Skill Parameter Response - Delete
Skill Authorization Request - Delete
Skill Authorization Response - Delete
Skill Group Request - Delete
Skill Group Response - Delete
User Request - Delete
User Response - Developer
Info The details about the developer that published the skill.
- Device
A device with attributes.
- Device
Data Device attributes.
- Device
Event The list of device events.
- Device
Network Profile Info Detailed information about a device's network profile.
- Device
Status Detail Details of a device’s status.
- Device
Status Info Detailed information about a device's status.
- Disassociate
Contact From Address Book Request - Disassociate
Contact From Address Book Response - Disassociate
Device From Room Request - Disassociate
Device From Room Response - Disassociate
Skill From Skill Group Request - Disassociate
Skill From Skill Group Response - Disassociate
Skill From Users Request - Disassociate
Skill From Users Response - Disassociate
Skill Group From Room Request - Disassociate
Skill Group From Room Response - EndOf
Meeting Reminder Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- Filter
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
- Forget
Smart Home Appliances Request - Forget
Smart Home Appliances Response - Gateway
The details of the gateway.
- Gateway
Group The details of the gateway group.
- Gateway
Group Summary The summary of a gateway group.
- Gateway
Summary The summary of a gateway.
- GetAddress
Book Request - GetAddress
Book Response - GetConference
Preference Request - GetConference
Preference Response - GetConference
Provider Request - GetConference
Provider Response - GetContact
Request - GetContact
Response - GetDevice
Request - GetDevice
Response - GetGateway
Group Request - GetGateway
Group Response - GetGateway
Request - GetGateway
Response - GetInvitation
Configuration Request - GetInvitation
Configuration Response - GetNetwork
Profile Request - GetNetwork
Profile Response - GetProfile
Request - GetProfile
Response - GetRoom
Request - GetRoom
Response - GetRoom
Skill Parameter Request - GetRoom
Skill Parameter Response - GetSkill
Group Request - GetSkill
Group Response - IPDial
In The IP endpoint and protocol for calling.
- Instant
Booking Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.
- List
Business Report Schedules Request - List
Business Report Schedules Response - List
Conference Providers Request - List
Conference Providers Response - List
Device Events Request - List
Device Events Response - List
Gateway Groups Request - List
Gateway Groups Response - List
Gateways Request - List
Gateways Response - List
Skills Request - List
Skills Response - List
Skills Store Categories Request - List
Skills Store Categories Response - List
Skills Store Skills ByCategory Request - List
Skills Store Skills ByCategory Response - List
Smart Home Appliances Request - List
Smart Home Appliances Response - List
Tags Request - List
Tags Response - Meeting
Room Configuration Meeting room settings of a room profile.
- Meeting
Setting The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.
-
If YES, Alexa will always ask for a meeting pin.
-
If NO, Alexa will never ask for a meeting pin.
-
If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.
-
- Network
Profile The network profile associated with a device.
- Network
Profile Data The data associated with a network profile.
- PSTN
Dial In The information for public switched telephone network (PSTN) conferencing.
- Phone
Number The phone number for the contact containing the raw number and phone number type.
- Profile
A room profile with attributes.
- Profile
Data The data of a room profile.
- PutConference
Preference Request - PutConference
Preference Response - PutInvitation
Configuration Request - PutInvitation
Configuration Response - PutRoom
Skill Parameter Request - PutRoom
Skill Parameter Response - PutSkill
Authorization Request - PutSkill
Authorization Response - RegisterAVS
Device Request - RegisterAVS
Device Response - Reject
Skill Request - Reject
Skill Response - Require
Check In Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
- Resolve
Room Request - Resolve
Room Response - Revoke
Invitation Request - Revoke
Invitation Response - Room
A room with attributes.
- Room
Data The data of a room.
- Room
Skill Parameter A skill parameter associated with a room.
- Search
Address Books Request - Search
Address Books Response - Search
Contacts Request - Search
Contacts Response - Search
Devices Request - Search
Devices Response - Search
Network Profiles Request - Search
Network Profiles Response - Search
Profiles Request - Search
Profiles Response - Search
Rooms Request - Search
Rooms Response - Search
Skill Groups Request - Search
Skill Groups Response - Search
Users Request - Search
Users Response - Send
Announcement Request - Send
Announcement Response - Send
Invitation Request - Send
Invitation Response - SipAddress
The SIP address for the contact containing the URI and SIP address type.
- Skill
Details Granular information about the skill.
- Skill
Group A skill group with attributes.
- Skill
Group Data The attributes of a skill group.
- Skill
Summary The summary of skills.
- Skills
Store Skill The detailed information about an Alexa skill.
- Smart
Home Appliance A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.
- Sort
An object representing a sort criteria.
- Ssml
The SSML message. For more information, see SSML Reference.
- Start
Device Sync Request - Start
Device Sync Response - Start
Smart Home Appliance Discovery Request - Start
Smart Home Appliance Discovery Response - Tag
A key-value pair that can be associated with a resource.
- TagResource
Request - TagResource
Response - Text
The text message.
- Untag
Resource Request - Untag
Resource Response - Update
Address Book Request - Update
Address Book Response - Update
Business Report Schedule Request - Update
Business Report Schedule Response - Update
Conference Provider Request - Update
Conference Provider Response - Update
Contact Request - Update
Contact Response - Update
Device Request - Update
Device Response - Update
EndOf Meeting Reminder Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
- Update
Gateway Group Request - Update
Gateway Group Response - Update
Gateway Request - Update
Gateway Response - Update
Instant Booking Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.
- Update
Meeting Room Configuration Updates meeting room settings of a room profile.
- Update
Network Profile Request - Update
Network Profile Response - Update
Profile Request - Update
Profile Response - Update
Require Check In Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.
- Update
Room Request - Update
Room Response - Update
Skill Group Request - Update
Skill Group Response - User
Data Information related to a user.
Enums§
- Approve
Skill Error - Errors returned by ApproveSkill
- Associate
Contact With Address Book Error - Errors returned by AssociateContactWithAddressBook
- Associate
Device With Network Profile Error - Errors returned by AssociateDeviceWithNetworkProfile
- Associate
Device With Room Error - Errors returned by AssociateDeviceWithRoom
- Associate
Skill Group With Room Error - Errors returned by AssociateSkillGroupWithRoom
- Associate
Skill With Skill Group Error - Errors returned by AssociateSkillWithSkillGroup
- Associate
Skill With Users Error - Errors returned by AssociateSkillWithUsers
- Create
Address Book Error - Errors returned by CreateAddressBook
- Create
Business Report Schedule Error - Errors returned by CreateBusinessReportSchedule
- Create
Conference Provider Error - Errors returned by CreateConferenceProvider
- Create
Contact Error - Errors returned by CreateContact
- Create
Gateway Group Error - Errors returned by CreateGatewayGroup
- Create
Network Profile Error - Errors returned by CreateNetworkProfile
- Create
Profile Error - Errors returned by CreateProfile
- Create
Room Error - Errors returned by CreateRoom
- Create
Skill Group Error - Errors returned by CreateSkillGroup
- Create
User Error - Errors returned by CreateUser
- Delete
Address Book Error - Errors returned by DeleteAddressBook
- Delete
Business Report Schedule Error - Errors returned by DeleteBusinessReportSchedule
- Delete
Conference Provider Error - Errors returned by DeleteConferenceProvider
- Delete
Contact Error - Errors returned by DeleteContact
- Delete
Device Error - Errors returned by DeleteDevice
- Delete
Device Usage Data Error - Errors returned by DeleteDeviceUsageData
- Delete
Gateway Group Error - Errors returned by DeleteGatewayGroup
- Delete
Network Profile Error - Errors returned by DeleteNetworkProfile
- Delete
Profile Error - Errors returned by DeleteProfile
- Delete
Room Error - Errors returned by DeleteRoom
- Delete
Room Skill Parameter Error - Errors returned by DeleteRoomSkillParameter
- Delete
Skill Authorization Error - Errors returned by DeleteSkillAuthorization
- Delete
Skill Group Error - Errors returned by DeleteSkillGroup
- Delete
User Error - Errors returned by DeleteUser
- Disassociate
Contact From Address Book Error - Errors returned by DisassociateContactFromAddressBook
- Disassociate
Device From Room Error - Errors returned by DisassociateDeviceFromRoom
- Disassociate
Skill From Skill Group Error - Errors returned by DisassociateSkillFromSkillGroup
- Disassociate
Skill From Users Error - Errors returned by DisassociateSkillFromUsers
- Disassociate
Skill Group From Room Error - Errors returned by DisassociateSkillGroupFromRoom
- Forget
Smart Home Appliances Error - Errors returned by ForgetSmartHomeAppliances
- GetAddress
Book Error - Errors returned by GetAddressBook
- GetConference
Preference Error - Errors returned by GetConferencePreference
- GetConference
Provider Error - Errors returned by GetConferenceProvider
- GetContact
Error - Errors returned by GetContact
- GetDevice
Error - Errors returned by GetDevice
- GetGateway
Error - Errors returned by GetGateway
- GetGateway
Group Error - Errors returned by GetGatewayGroup
- GetInvitation
Configuration Error - Errors returned by GetInvitationConfiguration
- GetNetwork
Profile Error - Errors returned by GetNetworkProfile
- GetProfile
Error - Errors returned by GetProfile
- GetRoom
Error - Errors returned by GetRoom
- GetRoom
Skill Parameter Error - Errors returned by GetRoomSkillParameter
- GetSkill
Group Error - Errors returned by GetSkillGroup
- List
Business Report Schedules Error - Errors returned by ListBusinessReportSchedules
- List
Conference Providers Error - Errors returned by ListConferenceProviders
- List
Device Events Error - Errors returned by ListDeviceEvents
- List
Gateway Groups Error - Errors returned by ListGatewayGroups
- List
Gateways Error - Errors returned by ListGateways
- List
Skills Error - Errors returned by ListSkills
- List
Skills Store Categories Error - Errors returned by ListSkillsStoreCategories
- List
Skills Store Skills ByCategory Error - Errors returned by ListSkillsStoreSkillsByCategory
- List
Smart Home Appliances Error - Errors returned by ListSmartHomeAppliances
- List
Tags Error - Errors returned by ListTags
- PutConference
Preference Error - Errors returned by PutConferencePreference
- PutInvitation
Configuration Error - Errors returned by PutInvitationConfiguration
- PutRoom
Skill Parameter Error - Errors returned by PutRoomSkillParameter
- PutSkill
Authorization Error - Errors returned by PutSkillAuthorization
- RegisterAVS
Device Error - Errors returned by RegisterAVSDevice
- Reject
Skill Error - Errors returned by RejectSkill
- Resolve
Room Error - Errors returned by ResolveRoom
- Revoke
Invitation Error - Errors returned by RevokeInvitation
- Search
Address Books Error - Errors returned by SearchAddressBooks
- Search
Contacts Error - Errors returned by SearchContacts
- Search
Devices Error - Errors returned by SearchDevices
- Search
Network Profiles Error - Errors returned by SearchNetworkProfiles
- Search
Profiles Error - Errors returned by SearchProfiles
- Search
Rooms Error - Errors returned by SearchRooms
- Search
Skill Groups Error - Errors returned by SearchSkillGroups
- Search
Users Error - Errors returned by SearchUsers
- Send
Announcement Error - Errors returned by SendAnnouncement
- Send
Invitation Error - Errors returned by SendInvitation
- Start
Device Sync Error - Errors returned by StartDeviceSync
- Start
Smart Home Appliance Discovery Error - Errors returned by StartSmartHomeApplianceDiscovery
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Address Book Error - Errors returned by UpdateAddressBook
- Update
Business Report Schedule Error - Errors returned by UpdateBusinessReportSchedule
- Update
Conference Provider Error - Errors returned by UpdateConferenceProvider
- Update
Contact Error - Errors returned by UpdateContact
- Update
Device Error - Errors returned by UpdateDevice
- Update
Gateway Error - Errors returned by UpdateGateway
- Update
Gateway Group Error - Errors returned by UpdateGatewayGroup
- Update
Network Profile Error - Errors returned by UpdateNetworkProfile
- Update
Profile Error - Errors returned by UpdateProfile
- Update
Room Error - Errors returned by UpdateRoom
- Update
Skill Group Error - Errors returned by UpdateSkillGroup
Traits§
- Alexa
ForBusiness - Trait representing the capabilities of the Alexa For Business API. Alexa For Business clients implement this trait.