Alexa For Business
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 93
- POSTApproveSkill
/#X-Amz-Target=AlexaForBusiness.ApproveSkillAssociates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during… - POSTAssociateContactWithAddressBook
/#X-Amz-Target=AlexaForBusiness.AssociateContactWithAddressBookAssociates a contact with a given address book. - POSTAssociateDeviceWithNetworkProfile
/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithNetworkProfileAssociates a device with the specified network profile. - POSTAssociateDeviceWithRoom
/#X-Amz-Target=AlexaForBusiness.AssociateDeviceWithRoomAssociates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that… - POSTAssociateSkillGroupWithRoom
/#X-Amz-Target=AlexaForBusiness.AssociateSkillGroupWithRoomAssociates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room. - POSTAssociateSkillWithSkillGroup
/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithSkillGroupAssociates a skill with a skill group. - POSTAssociateSkillWithUsers
/#X-Amz-Target=AlexaForBusiness.AssociateSkillWithUsersMakes a private skill available for enrolled users to enable on their devices. - POSTCreateAddressBook
/#X-Amz-Target=AlexaForBusiness.CreateAddressBookCreates an address book with the specified details. - POSTCreateBusinessReportSchedule
/#X-Amz-Target=AlexaForBusiness.CreateBusinessReportScheduleCreates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval. - POSTCreateConferenceProvider
/#X-Amz-Target=AlexaForBusiness.CreateConferenceProviderAdds a new conference provider under the user's AWS account. - POSTCreateContact
/#X-Amz-Target=AlexaForBusiness.CreateContactCreates a contact with the specified details. - POSTCreateGatewayGroup
/#X-Amz-Target=AlexaForBusiness.CreateGatewayGroupCreates a gateway group with the specified details. - POSTCreateNetworkProfile
/#X-Amz-Target=AlexaForBusiness.CreateNetworkProfileCreates a network profile with the specified details. - POSTCreateProfile
/#X-Amz-Target=AlexaForBusiness.CreateProfileCreates a new room profile with the specified details. - POSTCreateRoom
/#X-Amz-Target=AlexaForBusiness.CreateRoomCreates a room with the specified details. - POSTCreateSkillGroup
/#X-Amz-Target=AlexaForBusiness.CreateSkillGroupCreates a skill group with a specified name and description. - POSTCreateUser
/#X-Amz-Target=AlexaForBusiness.CreateUserCreates a user. - POSTDeleteAddressBook
/#X-Amz-Target=AlexaForBusiness.DeleteAddressBookDeletes an address book by the address book ARN. - POSTDeleteBusinessReportSchedule
/#X-Amz-Target=AlexaForBusiness.DeleteBusinessReportScheduleDeletes the recurring report delivery schedule with the specified schedule ARN. - POSTDeleteConferenceProvider
/#X-Amz-Target=AlexaForBusiness.DeleteConferenceProviderDeletes a conference provider. - POSTDeleteContact
/#X-Amz-Target=AlexaForBusiness.DeleteContactDeletes a contact by the contact ARN. - POSTDeleteDevice
/#X-Amz-Target=AlexaForBusiness.DeleteDeviceRemoves a device from Alexa For Business. - POSTDeleteDeviceUsageData
/#X-Amz-Target=AlexaForBusiness.DeleteDeviceUsageDataWhen this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and… - POSTDeleteGatewayGroup
/#X-Amz-Target=AlexaForBusiness.DeleteGatewayGroupDeletes a gateway group. - POSTDeleteNetworkProfile
/#X-Amz-Target=AlexaForBusiness.DeleteNetworkProfileDeletes a network profile by the network profile ARN. - POSTDeleteProfile
/#X-Amz-Target=AlexaForBusiness.DeleteProfileDeletes a room profile by the profile ARN. - POSTDeleteRoom
/#X-Amz-Target=AlexaForBusiness.DeleteRoomDeletes a room by the room ARN. - POSTDeleteRoomSkillParameter
/#X-Amz-Target=AlexaForBusiness.DeleteRoomSkillParameterDeletes room skill parameter details by room, skill, and parameter key ID. - POSTDeleteSkillAuthorization
/#X-Amz-Target=AlexaForBusiness.DeleteSkillAuthorizationUnlinks a third-party account from a skill. - POSTDeleteSkillGroup
/#X-Amz-Target=AlexaForBusiness.DeleteSkillGroupDeletes a skill group by skill group ARN. - POSTDeleteUser
/#X-Amz-Target=AlexaForBusiness.DeleteUserDeletes a specified user by user ARN and enrollment ARN. - POSTDisassociateContactFromAddressBook
/#X-Amz-Target=AlexaForBusiness.DisassociateContactFromAddressBookDisassociates a contact from a given address book. - POSTDisassociateDeviceFromRoom
/#X-Amz-Target=AlexaForBusiness.DisassociateDeviceFromRoomDisassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device… - POSTDisassociateSkillFromSkillGroup
/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromSkillGroupDisassociates a skill from a skill group. - POSTDisassociateSkillFromUsers
/#X-Amz-Target=AlexaForBusiness.DisassociateSkillFromUsersMakes a private skill unavailable for enrolled users and prevents them from enabling it on their devices. - POSTDisassociateSkillGroupFromRoom
/#X-Amz-Target=AlexaForBusiness.DisassociateSkillGroupFromRoomDisassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room. - POSTForgetSmartHomeAppliances
/#X-Amz-Target=AlexaForBusiness.ForgetSmartHomeAppliancesForgets smart home appliances associated to a room. - POSTGetAddressBook
/#X-Amz-Target=AlexaForBusiness.GetAddressBookGets address the book details by the address book ARN. - POSTGetConferencePreference
/#X-Amz-Target=AlexaForBusiness.GetConferencePreferenceRetrieves the existing conference preferences. - POSTGetConferenceProvider
/#X-Amz-Target=AlexaForBusiness.GetConferenceProviderGets details about a specific conference provider. - POSTGetContact
/#X-Amz-Target=AlexaForBusiness.GetContactGets the contact details by the contact ARN. - POSTGetDevice
/#X-Amz-Target=AlexaForBusiness.GetDeviceGets the details of a device by device ARN. - POSTGetGateway
/#X-Amz-Target=AlexaForBusiness.GetGatewayRetrieves the details of a gateway. - POSTGetGatewayGroup
/#X-Amz-Target=AlexaForBusiness.GetGatewayGroupRetrieves the details of a gateway group. - POSTGetInvitationConfiguration
/#X-Amz-Target=AlexaForBusiness.GetInvitationConfigurationRetrieves the configured values for the user enrollment invitation email template. - POSTGetNetworkProfile
/#X-Amz-Target=AlexaForBusiness.GetNetworkProfileGets the network profile details by the network profile ARN. - POSTGetProfile
/#X-Amz-Target=AlexaForBusiness.GetProfileGets the details of a room profile by profile ARN. - POSTGetRoom
/#X-Amz-Target=AlexaForBusiness.GetRoomGets room details by room ARN. - POSTGetRoomSkillParameter
/#X-Amz-Target=AlexaForBusiness.GetRoomSkillParameterGets room skill parameter details by room, skill, and parameter key ARN. - POSTGetSkillGroup
/#X-Amz-Target=AlexaForBusiness.GetSkillGroupGets skill group details by skill group ARN. - POSTListBusinessReportSchedules
/#X-Amz-Target=AlexaForBusiness.ListBusinessReportSchedules?MaxResults=string&NextToken=stringLists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is… - POSTListConferenceProviders
/#X-Amz-Target=AlexaForBusiness.ListConferenceProviders?MaxResults=string&NextToken=stringLists conference providers under a specific AWS account. - POSTListDeviceEvents
/#X-Amz-Target=AlexaForBusiness.ListDeviceEvents?MaxResults=string&NextToken=stringLists the device event history, including device connection status, for up to 30 days. - POSTListGatewayGroups
/#X-Amz-Target=AlexaForBusiness.ListGatewayGroups?MaxResults=string&NextToken=stringRetrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group. - POSTListGateways
/#X-Amz-Target=AlexaForBusiness.ListGateways?MaxResults=string&NextToken=stringRetrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only… - POSTListSkills
/#X-Amz-Target=AlexaForBusiness.ListSkills?MaxResults=string&NextToken=stringLists all enabled skills in a specific skill group. - POSTListSkillsStoreCategories
/#X-Amz-Target=AlexaForBusiness.ListSkillsStoreCategories?MaxResults=string&NextToken=stringLists all categories in the Alexa skill store. - POSTListSkillsStoreSkillsByCategory
/#X-Amz-Target=AlexaForBusiness.ListSkillsStoreSkillsByCategory?MaxResults=string&NextToken=stringLists all skills in the Alexa skill store by category. - POSTListSmartHomeAppliances
/#X-Amz-Target=AlexaForBusiness.ListSmartHomeAppliances?MaxResults=string&NextToken=stringLists all of the smart home appliances associated with a room. - POSTListTags
/#X-Amz-Target=AlexaForBusiness.ListTags?MaxResults=string&NextToken=stringLists all tags for the specified resource. - POSTPutConferencePreference
/#X-Amz-Target=AlexaForBusiness.PutConferencePreferenceSets the conference preferences on a specific conference provider at the account level. - POSTPutInvitationConfiguration
/#X-Amz-Target=AlexaForBusiness.PutInvitationConfigurationConfigures the email template for the user enrollment invitation with the specified attributes. - POSTPutRoomSkillParameter
/#X-Amz-Target=AlexaForBusiness.PutRoomSkillParameterUpdates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter. - POSTPutSkillAuthorization
/#X-Amz-Target=AlexaForBusiness.PutSkillAuthorizationLinks a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private… - POSTRegisterAVSDevice
/#X-Amz-Target=AlexaForBusiness.RegisterAVSDeviceRegisters an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS). - POSTRejectSkill
/#X-Amz-Target=AlexaForBusiness.RejectSkillDisassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private… - POSTResolveRoom
/#X-Amz-Target=AlexaForBusiness.ResolveRoom<p>Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.</p> <p>To query ResolveRoom from an… - POSTRevokeInvitation
/#X-Amz-Target=AlexaForBusiness.RevokeInvitationRevokes an invitation and invalidates the enrollment URL. - POSTSearchAddressBooks
/#X-Amz-Target=AlexaForBusiness.SearchAddressBooks?MaxResults=string&NextToken=stringSearches address books and lists the ones that meet a set of filter and sort criteria. - POSTSearchContacts
/#X-Amz-Target=AlexaForBusiness.SearchContacts?MaxResults=string&NextToken=stringSearches contacts and lists the ones that meet a set of filter and sort criteria. - POSTSearchDevices
/#X-Amz-Target=AlexaForBusiness.SearchDevices?MaxResults=string&NextToken=stringSearches devices and lists the ones that meet a set of filter criteria. - POSTSearchNetworkProfiles
/#X-Amz-Target=AlexaForBusiness.SearchNetworkProfiles?MaxResults=string&NextToken=stringSearches network profiles and lists the ones that meet a set of filter and sort criteria. - POSTSearchProfiles
/#X-Amz-Target=AlexaForBusiness.SearchProfiles?MaxResults=string&NextToken=stringSearches room profiles and lists the ones that meet a set of filter criteria. - POSTSearchRooms
/#X-Amz-Target=AlexaForBusiness.SearchRooms?MaxResults=string&NextToken=stringSearches rooms and lists the ones that meet a set of filter and sort criteria. - POSTSearchSkillGroups
/#X-Amz-Target=AlexaForBusiness.SearchSkillGroups?MaxResults=string&NextToken=stringSearches skill groups and lists the ones that meet a set of filter and sort criteria. - POSTSearchUsers
/#X-Amz-Target=AlexaForBusiness.SearchUsers?MaxResults=string&NextToken=stringSearches users and lists the ones that meet a set of filter and sort criteria. - POSTSendAnnouncement
/#X-Amz-Target=AlexaForBusiness.SendAnnouncementTriggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter. - POSTSendInvitation
/#X-Amz-Target=AlexaForBusiness.SendInvitationSends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first. - POSTStartDeviceSync
/#X-Amz-Target=AlexaForBusiness.StartDeviceSync<p>Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:</p>… - POSTStartSmartHomeApplianceDiscovery
/#X-Amz-Target=AlexaForBusiness.StartSmartHomeApplianceDiscoveryInitiates the discovery of any smart home appliances associated with the room. - POSTTagResource
/#X-Amz-Target=AlexaForBusiness.TagResourceAdds metadata tags to a specified resource. - POSTUntagResource
/#X-Amz-Target=AlexaForBusiness.UntagResourceRemoves metadata tags from a specified resource. - POSTUpdateAddressBook
/#X-Amz-Target=AlexaForBusiness.UpdateAddressBookUpdates address book details by the address book ARN. - POSTUpdateBusinessReportSchedule
/#X-Amz-Target=AlexaForBusiness.UpdateBusinessReportScheduleUpdates the configuration of the report delivery schedule with the specified schedule ARN. - POSTUpdateConferenceProvider
/#X-Amz-Target=AlexaForBusiness.UpdateConferenceProviderUpdates an existing conference provider's settings. - POSTUpdateContact
/#X-Amz-Target=AlexaForBusiness.UpdateContactUpdates the contact details by the contact ARN. - POSTUpdateDevice
/#X-Amz-Target=AlexaForBusiness.UpdateDeviceUpdates the device name by device ARN. - POSTUpdateGateway
/#X-Amz-Target=AlexaForBusiness.UpdateGatewayUpdates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified. - POSTUpdateGatewayGroup
/#X-Amz-Target=AlexaForBusiness.UpdateGatewayGroupUpdates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified. - POSTUpdateNetworkProfile
/#X-Amz-Target=AlexaForBusiness.UpdateNetworkProfileUpdates a network profile by the network profile ARN. - POSTUpdateProfile
/#X-Amz-Target=AlexaForBusiness.UpdateProfileUpdates an existing room profile by room profile ARN. - POSTUpdateRoom
/#X-Amz-Target=AlexaForBusiness.UpdateRoomUpdates room details by room ARN. - POSTUpdateSkillGroup
/#X-Amz-Target=AlexaForBusiness.UpdateSkillGroupUpdates skill group details by skill group ARN.
API details
- Base URL
http://a4b.{region}.amazonaws.comhttps://a4b.{region}.amazonaws.comhttp://a4b.{region}.amazonaws.com.cnhttps://a4b.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 93 operations on 93 pathsPOST 93
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2017-11-09 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Alexa For Business in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Alexa For Business collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ApproveSkill” (POST /#X-Amz-Target=AlexaForBusiness.ApproveSkill), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Alexa For Business?
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… It is listed under Developer tools and has 93 endpoints.
Who publishes the Alexa For Business?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Alexa For Business?
Its description lists 4 base URLs: http://a4b.{region}.amazonaws.com, https://a4b.{region}.amazonaws.com, http://a4b.{region}.amazonaws.com.cn, https://a4b.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Alexa For Business?
With an API key in the Authorization header.
How many endpoints does the Alexa For Business have?
93 operations on 93 paths (93 POST).
Is forking the Alexa For Business free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.