ebook img

Alexa for Business API PDF

249 Pages·2017·2.04 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Alexa for Business API

Alexa for Business Alexa for Business API API Version 2017-11-09 Alexa for Business Alexa for Business API Alexa for Business: Alexa for Business API Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Alexa for Business Alexa for Business API Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 2 ApproveSkill.............................................................................................................................. 5 Request Syntax.................................................................................................................. 5 Request Parameters............................................................................................................ 5 Response Elements............................................................................................................. 5 Errors............................................................................................................................... 5 See Also............................................................................................................................ 6 AssociateContactWithAddressBook............................................................................................... 7 Request Syntax.................................................................................................................. 7 Request Parameters............................................................................................................ 7 Response Elements............................................................................................................. 7 Errors............................................................................................................................... 7 See Also............................................................................................................................ 8 AssociateDeviceWithNetworkProfile.............................................................................................. 9 Request Syntax.................................................................................................................. 9 Request Parameters............................................................................................................ 9 Response Elements............................................................................................................. 9 Errors............................................................................................................................... 9 See Also.......................................................................................................................... 10 AssociateDeviceWithRoom......................................................................................................... 11 Request Syntax................................................................................................................ 11 Request Parameters.......................................................................................................... 11 Response Elements........................................................................................................... 11 Errors.............................................................................................................................. 11 See Also.......................................................................................................................... 12 AssociateSkillGroupWithRoom.................................................................................................... 13 Request Syntax................................................................................................................ 13 Request Parameters.......................................................................................................... 13 Response Elements........................................................................................................... 13 Errors.............................................................................................................................. 13 See Also.......................................................................................................................... 14 AssociateSkillWithSkillGroup...................................................................................................... 15 Request Syntax................................................................................................................ 15 Request Parameters.......................................................................................................... 15 Response Elements........................................................................................................... 15 Errors.............................................................................................................................. 15 See Also.......................................................................................................................... 16 AssociateSkillWithUsers............................................................................................................. 17 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 17 Response Elements........................................................................................................... 17 Errors.............................................................................................................................. 17 See Also.......................................................................................................................... 17 CreateAddressBook................................................................................................................... 19 Request Syntax................................................................................................................ 19 Request Parameters.......................................................................................................... 19 Response Syntax.............................................................................................................. 20 Response Elements........................................................................................................... 20 Errors.............................................................................................................................. 20 See Also.......................................................................................................................... 20 CreateBusinessReportSchedule................................................................................................... 22 Request Syntax................................................................................................................ 22 Request Parameters.......................................................................................................... 22 API Version 2017-11-09 iii Alexa for Business Alexa for Business API Response Syntax.............................................................................................................. 23 Response Elements........................................................................................................... 24 Errors.............................................................................................................................. 24 See Also.......................................................................................................................... 24 CreateConferenceProvider.......................................................................................................... 25 Request Syntax................................................................................................................ 25 Request Parameters.......................................................................................................... 25 Response Syntax.............................................................................................................. 26 Response Elements........................................................................................................... 26 Errors.............................................................................................................................. 27 See Also.......................................................................................................................... 27 CreateContact.......................................................................................................................... 28 Request Syntax................................................................................................................ 28 Request Parameters.......................................................................................................... 28 Response Syntax.............................................................................................................. 30 Response Elements........................................................................................................... 30 Errors.............................................................................................................................. 30 See Also.......................................................................................................................... 30 CreateGatewayGroup................................................................................................................ 32 Request Syntax................................................................................................................ 32 Request Parameters.......................................................................................................... 32 Response Syntax.............................................................................................................. 33 Response Elements........................................................................................................... 33 Errors.............................................................................................................................. 33 See Also.......................................................................................................................... 33 CreateNetworkProfile................................................................................................................ 35 Request Syntax................................................................................................................ 35 Request Parameters.......................................................................................................... 35 Response Syntax.............................................................................................................. 37 Response Elements........................................................................................................... 37 Errors.............................................................................................................................. 38 See Also.......................................................................................................................... 38 CreateProfile............................................................................................................................ 39 Request Syntax................................................................................................................ 39 Request Parameters.......................................................................................................... 39 Response Syntax.............................................................................................................. 41 Response Elements........................................................................................................... 41 Errors.............................................................................................................................. 42 See Also.......................................................................................................................... 42 CreateRoom............................................................................................................................. 43 Request Syntax................................................................................................................ 43 Request Parameters.......................................................................................................... 43 Response Syntax.............................................................................................................. 44 Response Elements........................................................................................................... 44 Errors.............................................................................................................................. 44 See Also.......................................................................................................................... 45 CreateSkillGroup...................................................................................................................... 46 Request Syntax................................................................................................................ 46 Request Parameters.......................................................................................................... 46 Response Syntax.............................................................................................................. 47 Response Elements........................................................................................................... 47 Errors.............................................................................................................................. 47 See Also.......................................................................................................................... 47 CreateUser............................................................................................................................... 49 Request Syntax................................................................................................................ 49 Request Parameters.......................................................................................................... 49 Response Syntax.............................................................................................................. 50 API Version 2017-11-09 iv Alexa for Business Alexa for Business API Response Elements........................................................................................................... 50 Errors.............................................................................................................................. 50 See Also.......................................................................................................................... 51 DeleteAddressBook................................................................................................................... 52 Request Syntax................................................................................................................ 52 Request Parameters.......................................................................................................... 52 Response Elements........................................................................................................... 52 Errors.............................................................................................................................. 52 See Also.......................................................................................................................... 52 DeleteBusinessReportSchedule................................................................................................... 54 Request Syntax................................................................................................................ 54 Request Parameters.......................................................................................................... 54 Response Elements........................................................................................................... 54 Errors.............................................................................................................................. 54 See Also.......................................................................................................................... 54 DeleteConferenceProvider.......................................................................................................... 56 Request Syntax................................................................................................................ 56 Request Parameters.......................................................................................................... 56 Response Elements........................................................................................................... 56 Errors.............................................................................................................................. 56 See Also.......................................................................................................................... 56 DeleteContact.......................................................................................................................... 58 Request Syntax................................................................................................................ 58 Request Parameters.......................................................................................................... 58 Response Elements........................................................................................................... 58 Errors.............................................................................................................................. 58 See Also.......................................................................................................................... 58 DeleteDevice............................................................................................................................ 60 Request Syntax................................................................................................................ 60 Request Parameters.......................................................................................................... 60 Response Elements........................................................................................................... 60 Errors.............................................................................................................................. 60 See Also.......................................................................................................................... 60 DeleteDeviceUsageData............................................................................................................. 62 Request Syntax................................................................................................................ 62 Request Parameters.......................................................................................................... 62 Response Elements........................................................................................................... 62 Errors.............................................................................................................................. 62 See Also.......................................................................................................................... 63 DeleteGatewayGroup................................................................................................................ 64 Request Syntax................................................................................................................ 64 Request Parameters.......................................................................................................... 64 Response Elements........................................................................................................... 64 Errors.............................................................................................................................. 64 See Also.......................................................................................................................... 64 DeleteNetworkProfile................................................................................................................ 66 Request Syntax................................................................................................................ 66 Request Parameters.......................................................................................................... 66 Response Elements........................................................................................................... 66 Errors.............................................................................................................................. 66 See Also.......................................................................................................................... 66 DeleteProfile............................................................................................................................ 68 Request Syntax................................................................................................................ 68 Request Parameters.......................................................................................................... 68 Response Elements........................................................................................................... 68 Errors.............................................................................................................................. 68 See Also.......................................................................................................................... 68 API Version 2017-11-09 v Alexa for Business Alexa for Business API DeleteRoom............................................................................................................................. 70 Request Syntax................................................................................................................ 70 Request Parameters.......................................................................................................... 70 Response Elements........................................................................................................... 70 Errors.............................................................................................................................. 70 See Also.......................................................................................................................... 70 DeleteRoomSkillParameter........................................................................................................ 72 Request Syntax................................................................................................................ 72 Request Parameters.......................................................................................................... 72 Response Elements........................................................................................................... 72 Errors.............................................................................................................................. 72 See Also.......................................................................................................................... 73 DeleteSkillAuthorization............................................................................................................ 74 Request Syntax................................................................................................................ 74 Request Parameters.......................................................................................................... 74 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 74 See Also.......................................................................................................................... 75 DeleteSkillGroup...................................................................................................................... 76 Request Syntax................................................................................................................ 76 Request Parameters.......................................................................................................... 76 Response Elements........................................................................................................... 76 Errors.............................................................................................................................. 76 See Also.......................................................................................................................... 76 DeleteUser............................................................................................................................... 78 Request Syntax................................................................................................................ 78 Request Parameters.......................................................................................................... 78 Response Elements........................................................................................................... 78 Errors.............................................................................................................................. 78 See Also.......................................................................................................................... 79 DisassociateContactFromAddressBook......................................................................................... 80 Request Syntax................................................................................................................ 80 Request Parameters.......................................................................................................... 80 Response Elements........................................................................................................... 80 Errors.............................................................................................................................. 80 See Also.......................................................................................................................... 80 DisassociateDeviceFromRoom..................................................................................................... 82 Request Syntax................................................................................................................ 82 Request Parameters.......................................................................................................... 82 Response Elements........................................................................................................... 82 Errors.............................................................................................................................. 82 See Also.......................................................................................................................... 82 DisassociateSkillFromSkillGroup................................................................................................. 84 Request Syntax................................................................................................................ 84 Request Parameters.......................................................................................................... 84 Response Elements........................................................................................................... 84 Errors.............................................................................................................................. 84 See Also.......................................................................................................................... 85 DisassociateSkillFromUsers........................................................................................................ 86 Request Syntax................................................................................................................ 86 Request Parameters.......................................................................................................... 86 Response Elements........................................................................................................... 86 Errors.............................................................................................................................. 86 See Also.......................................................................................................................... 86 DisassociateSkillGroupFromRoom............................................................................................... 88 Request Syntax................................................................................................................ 88 Request Parameters.......................................................................................................... 88 API Version 2017-11-09 vi Alexa for Business Alexa for Business API Response Elements........................................................................................................... 88 Errors.............................................................................................................................. 88 See Also.......................................................................................................................... 89 ForgetSmartHomeAppliances..................................................................................................... 90 Request Syntax................................................................................................................ 90 Request Parameters.......................................................................................................... 90 Response Elements........................................................................................................... 90 Errors.............................................................................................................................. 90 See Also.......................................................................................................................... 90 GetAddressBook....................................................................................................................... 92 Request Syntax................................................................................................................ 92 Request Parameters.......................................................................................................... 92 Response Syntax.............................................................................................................. 92 Response Elements........................................................................................................... 92 Errors.............................................................................................................................. 92 See Also.......................................................................................................................... 93 GetConferencePreference.......................................................................................................... 94 Response Syntax.............................................................................................................. 94 Response Elements........................................................................................................... 94 Errors.............................................................................................................................. 94 See Also.......................................................................................................................... 94 GetConferenceProvider.............................................................................................................. 95 Request Syntax................................................................................................................ 95 Request Parameters.......................................................................................................... 95 Response Syntax.............................................................................................................. 95 Response Elements........................................................................................................... 95 Errors.............................................................................................................................. 96 See Also.......................................................................................................................... 96 GetContact.............................................................................................................................. 97 Request Syntax................................................................................................................ 97 Request Parameters.......................................................................................................... 97 Response Syntax.............................................................................................................. 97 Response Elements........................................................................................................... 97 Errors.............................................................................................................................. 98 See Also.......................................................................................................................... 98 GetDevice................................................................................................................................ 99 Request Syntax................................................................................................................ 99 Request Parameters.......................................................................................................... 99 Response Syntax.............................................................................................................. 99 Response Elements......................................................................................................... 100 Errors............................................................................................................................ 100 See Also........................................................................................................................ 100 GetGateway........................................................................................................................... 101 Request Syntax.............................................................................................................. 101 Request Parameters........................................................................................................ 101 Response Syntax............................................................................................................ 101 Response Elements......................................................................................................... 101 Errors............................................................................................................................ 101 See Also........................................................................................................................ 102 GetGatewayGroup................................................................................................................... 103 Request Syntax.............................................................................................................. 103 Request Parameters........................................................................................................ 103 Response Syntax............................................................................................................ 103 Response Elements......................................................................................................... 103 Errors............................................................................................................................ 103 See Also........................................................................................................................ 104 GetInvitationConfiguration....................................................................................................... 105 API Version 2017-11-09 vii Alexa for Business Alexa for Business API Response Syntax............................................................................................................ 105 Response Elements......................................................................................................... 105 Errors............................................................................................................................ 105 See Also........................................................................................................................ 106 GetNetworkProfile.................................................................................................................. 107 Request Syntax.............................................................................................................. 107 Request Parameters........................................................................................................ 107 Response Syntax............................................................................................................ 107 Response Elements......................................................................................................... 107 Errors............................................................................................................................ 108 See Also........................................................................................................................ 108 GetProfile.............................................................................................................................. 109 Request Syntax.............................................................................................................. 109 Request Parameters........................................................................................................ 109 Response Syntax............................................................................................................ 109 Response Elements......................................................................................................... 110 Errors............................................................................................................................ 110 See Also........................................................................................................................ 110 GetRoom............................................................................................................................... 111 Request Syntax.............................................................................................................. 111 Request Parameters........................................................................................................ 111 Response Syntax............................................................................................................ 111 Response Elements......................................................................................................... 111 Errors............................................................................................................................ 111 See Also........................................................................................................................ 112 GetRoomSkillParameter........................................................................................................... 113 Request Syntax.............................................................................................................. 113 Request Parameters........................................................................................................ 113 Response Syntax............................................................................................................ 113 Response Elements......................................................................................................... 114 Errors............................................................................................................................ 114 See Also........................................................................................................................ 114 GetSkillGroup......................................................................................................................... 115 Request Syntax.............................................................................................................. 115 Request Parameters........................................................................................................ 115 Response Syntax............................................................................................................ 115 Response Elements......................................................................................................... 115 Errors............................................................................................................................ 115 See Also........................................................................................................................ 116 ListBusinessReportSchedules.................................................................................................... 117 Request Syntax.............................................................................................................. 117 Request Parameters........................................................................................................ 117 Response Syntax............................................................................................................ 117 Response Elements......................................................................................................... 118 Errors............................................................................................................................ 118 See Also........................................................................................................................ 118 ListConferenceProviders........................................................................................................... 119 Request Syntax.............................................................................................................. 119 Request Parameters........................................................................................................ 119 Response Syntax............................................................................................................ 119 Response Elements......................................................................................................... 120 Errors............................................................................................................................ 120 See Also........................................................................................................................ 120 ListDeviceEvents..................................................................................................................... 121 Request Syntax.............................................................................................................. 121 Request Parameters........................................................................................................ 121 Response Syntax............................................................................................................ 122 API Version 2017-11-09 viii Alexa for Business Alexa for Business API Response Elements......................................................................................................... 122 Errors............................................................................................................................ 122 See Also........................................................................................................................ 122 ListGatewayGroups................................................................................................................. 124 Request Syntax.............................................................................................................. 124 Request Parameters........................................................................................................ 124 Response Syntax............................................................................................................ 124 Response Elements......................................................................................................... 124 Errors............................................................................................................................ 125 See Also........................................................................................................................ 125 ListGateways.......................................................................................................................... 126 Request Syntax.............................................................................................................. 126 Request Parameters........................................................................................................ 126 Response Syntax............................................................................................................ 126 Response Elements......................................................................................................... 127 Errors............................................................................................................................ 127 See Also........................................................................................................................ 127 ListSkills................................................................................................................................ 128 Request Syntax.............................................................................................................. 128 Request Parameters........................................................................................................ 128 Response Syntax............................................................................................................ 129 Response Elements......................................................................................................... 129 Errors............................................................................................................................ 129 See Also........................................................................................................................ 129 ListSkillsStoreCategories.......................................................................................................... 131 Request Syntax.............................................................................................................. 131 Request Parameters........................................................................................................ 131 Response Syntax............................................................................................................ 131 Response Elements......................................................................................................... 131 Errors............................................................................................................................ 132 See Also........................................................................................................................ 132 ListSkillsStoreSkillsByCategory................................................................................................. 133 Request Syntax.............................................................................................................. 133 Request Parameters........................................................................................................ 133 Response Syntax............................................................................................................ 133 Response Elements......................................................................................................... 134 Errors............................................................................................................................ 134 See Also........................................................................................................................ 134 ListSmartHomeAppliances....................................................................................................... 136 Request Syntax.............................................................................................................. 136 Request Parameters........................................................................................................ 136 Response Syntax............................................................................................................ 136 Response Elements......................................................................................................... 137 Errors............................................................................................................................ 137 See Also........................................................................................................................ 137 ListTags................................................................................................................................. 138 Request Syntax.............................................................................................................. 138 Request Parameters........................................................................................................ 138 Response Syntax............................................................................................................ 138 Response Elements......................................................................................................... 139 Errors............................................................................................................................ 139 See Also........................................................................................................................ 139 PutConferencePreference......................................................................................................... 140 Request Syntax.............................................................................................................. 140 Request Parameters........................................................................................................ 140 Response Elements......................................................................................................... 140 Errors............................................................................................................................ 140 API Version 2017-11-09 ix Alexa for Business Alexa for Business API See Also........................................................................................................................ 140 PutInvitationConfiguration....................................................................................................... 142 Request Syntax.............................................................................................................. 142 Request Parameters........................................................................................................ 142 Response Elements......................................................................................................... 143 Errors............................................................................................................................ 143 See Also........................................................................................................................ 143 PutRoomSkillParameter........................................................................................................... 144 Request Syntax.............................................................................................................. 144 Request Parameters........................................................................................................ 144 Response Elements......................................................................................................... 144 Errors............................................................................................................................ 145 See Also........................................................................................................................ 145 PutSkillAuthorization.............................................................................................................. 146 Request Syntax.............................................................................................................. 146 Request Parameters........................................................................................................ 146 Response Elements......................................................................................................... 147 Errors............................................................................................................................ 147 See Also........................................................................................................................ 147 RegisterAVSDevice.................................................................................................................. 148 Request Syntax.............................................................................................................. 148 Request Parameters........................................................................................................ 148 Response Syntax............................................................................................................ 149 Response Elements......................................................................................................... 149 Errors............................................................................................................................ 150 See Also........................................................................................................................ 150 RejectSkill.............................................................................................................................. 151 Request Syntax.............................................................................................................. 151 Request Parameters........................................................................................................ 151 Response Elements......................................................................................................... 151 Errors............................................................................................................................ 151 See Also........................................................................................................................ 151 ResolveRoom......................................................................................................................... 153 Request Syntax.............................................................................................................. 153 Request Parameters........................................................................................................ 153 Response Syntax............................................................................................................ 153 Response Elements......................................................................................................... 154 Errors............................................................................................................................ 154 See Also........................................................................................................................ 154 RevokeInvitation..................................................................................................................... 156 Request Syntax.............................................................................................................. 156 Request Parameters........................................................................................................ 156 Response Elements......................................................................................................... 156 Errors............................................................................................................................ 156 See Also........................................................................................................................ 157 SearchAddressBooks............................................................................................................... 158 Request Syntax.............................................................................................................. 158 Request Parameters........................................................................................................ 158 Response Syntax............................................................................................................ 159 Response Elements......................................................................................................... 159 Errors............................................................................................................................ 159 See Also........................................................................................................................ 160 SearchContacts....................................................................................................................... 161 Request Syntax.............................................................................................................. 161 Request Parameters........................................................................................................ 161 Response Syntax............................................................................................................ 162 Response Elements......................................................................................................... 162 API Version 2017-11-09 x

Description:
Amazon's trademarks and trade dress may not be used in connection with any product or the service sends back an HTTP 200 response with an empty HTTP body. using this API in one of the language-specific AWS SDKs, see the following: and all the skills in any skill groups added to that room.
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.