Alexa For Business - Alexa for Business API

1 Alexa For BusinessAlexa for Business APIAPI Version 2017-11-09 Alexa For Business Alexa for Business APIA lexa For Business : Alexa for Business APIC opyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored For Business Alexa for Business APIT able of ContentsWelcome .. 1 Actions .. 2 ApproveSkill .. 4 Request Syntax .. 4 Request Parameters .. 4 Response Elements .. 4 Errors .. 4 See 4 AssociateContactWithAddressBook .. 6 Request Syntax .. 6 Request Parameters .. 6 Response Elements .. 6 Errors .. 6 See 7 AssociateDeviceWithRoom.

2 8 Request Syntax .. 8 Request Parameters .. 8 Response Elements .. 8 Errors .. 8 See 9 AssociateSkillGroupWithRoom .. 10 Request Syntax .. 10 Request Parameters .. 10 Response Elements .. 10 Errors .. 10 See 10 AssociateSkillWithSkillGroup .. 12 Request Syntax .. 12 Request Parameters .. 12 Response Elements .. 12 Errors .. 12 See 13 CreateAddressBook .. 14 Request Syntax .. 14 Request Parameters .. 14 Response Syntax .. 15 Response Elements .. 15 Errors .. 15 See 15 CreateConferenceProvider .. 16 Request Syntax .. 16 Request Parameters .. 16 Response Syntax .. 17 Response Elements .. 17 Errors .. 17 See 18 CreateContact .. 19 Request Syntax .. 19 Request Parameters .. 19 Response Syntax .. 20 Response Elements .. 20 Errors .. 20 See 21 CreateProfile .. 22 API Version 2017-11-09iiiAlexa For Business Alexa for Business APIR equest Syntax .. 22 Request Parameters .. 22 Response Syntax .. 23 Response Elements.

3 24 Errors .. 24 See 24 CreateRoom .. 25 Request Syntax .. 25 Request Parameters .. 25 Response Syntax .. 26 Response Elements .. 26 Errors .. 26 See 27 CreateSkillGroup .. 28 Request Syntax .. 28 Request Parameters .. 28 Response Syntax .. 29 Response Elements .. 29 Errors .. 29 See 29 CreateUser .. 31 Request Syntax .. 31 Request Parameters .. 31 Response Syntax .. 32 Response Elements .. 32 Errors .. 32 See 33 DeleteAddressBook .. 34 Request Syntax .. 34 Request Parameters .. 34 Response Elements .. 34 Errors .. 34 See 34 DeleteConferenceProvider .. 36 Request Syntax .. 36 Request Parameters .. 36 Response Elements .. 36 Errors .. 36 See 36 DeleteContact .. 38 Request Syntax .. 38 Request Parameters .. 38 Response Elements .. 38 Errors .. 38 See 38 DeleteDevice .. 40 Request Syntax .. 40 Request Parameters .. 40 Response Elements .. 40 Errors .. 40 See 40 DeleteProfile .. 42 Request Syntax .. 42 Request Parameters.

4 42 Response Elements .. 42 Errors .. 42 See 42 API Version 2017-11-09ivAlexa For Business Alexa for Business APID eleteRoom .. 44 Request Syntax .. 44 Request Parameters .. 44 Response Elements .. 44 Errors .. 44 See 44 DeleteRoomSkillParameter .. 46 Request Syntax .. 46 Request Parameters .. 46 Response Elements .. 46 Errors .. 46 See 48 Request Syntax .. 48 Request Parameters .. 48 Response Elements .. 48 Errors .. 48 See 49 DeleteSkillGroup .. 50 Request Syntax .. 50 Request Parameters .. 50 Response Elements .. 50 Errors .. 50 See 52 Request Syntax .. 52 Request Parameters .. 52 Response Elements .. 52 Errors .. 52 See 53 DisassociateContactFromAddressBook .. 54 Request Syntax .. 54 Request Parameters .. 54 Response Elements .. 54 Errors .. 54 See 54 DisassociateDeviceFromRoom .. 56 Request Syntax .. 56 Request Parameters .. 56 Response Elements .. 56 Errors .. 56 See 56 DisassociateSkillFromSkillGroup.

5 58 Request Syntax .. 58 Request Parameters .. 58 Response Elements .. 58 Errors .. 58 See 59 DisassociateSkillGroupFromRoom .. 60 Request Syntax .. 60 Request Parameters .. 60 Response Elements .. 60 Errors .. 60 See 60 ForgetSmartHomeAppliances .. 62 Request Syntax .. 62 Request Parameters .. 62 API Version 2017-11-09vAlexa For Business Alexa for Business APIR esponse Elements .. 62 Errors .. 62 See 62 GetAddressBook .. 64 Request Syntax .. 64 Request Parameters .. 64 Response Syntax .. 64 Response Elements .. 64 Errors .. 64 See 65 GetConferencePreference .. 66 Response Syntax .. 66 Response Elements .. 66 Errors .. 66 See 66 GetConferenceProvider .. 67 Request Syntax .. 67 Request Parameters .. 67 Response Syntax .. 67 Response Elements .. 67 Errors .. 68 See 68 GetContact .. 69 Request Syntax .. 69 Request Parameters .. 69 Response Syntax .. 69 Response Elements .. 69 Errors .. 69 See 70 GetDevice.

6 71 Request Syntax .. 71 Request Parameters .. 71 Response Syntax .. 71 Response Elements .. 71 Errors .. 72 See 72 GetProfile .. 73 Request Syntax .. 73 Request Parameters .. 73 Response Syntax .. 73 Response Elements .. 73 Errors .. 74 See 74 GetRoom .. 75 Request Syntax .. 75 Request Parameters .. 75 Response Syntax .. 75 Response Elements .. 75 Errors .. 75 See 76 GetRoomSkillParameter .. 77 Request Syntax .. 77 Request Parameters .. 77 Response Syntax .. 77 Response Elements .. 78 Errors .. 78 See 78 API Version 2017-11-09viAlexa For Business Alexa for Business APIGetSkillGroup .. 79 Request Syntax .. 79 Request Parameters .. 79 Response Syntax .. 79 Response Elements .. 79 Errors .. 79 See 80 ListConferenceProviders .. 81 Request Syntax .. 81 Request Parameters .. 81 Response Syntax .. 81 Response Elements .. 82 Errors .. 82 See 82 ListDeviceEvents .. 83 Request Syntax .. 83 Request Parameters.

7 83 Response Syntax .. 84 Response Elements .. 84 Errors .. 84 See 86 Request Syntax .. 86 Request Parameters .. 86 Response Syntax .. 87 Response Elements .. 87 Errors .. 87 See 87 ListSkillsStoreCategories .. 89 Request Syntax .. 89 Request Parameters .. 89 Response Syntax .. 89 Response Elements .. 89 Errors .. 90 See 90 ListSkillsStoreSkillsByCategory .. 91 Request Syntax .. 91 Request Parameters .. 91 Response Syntax .. 91 Response Elements .. 92 Errors .. 92 See 92 ListSmartHomeAppliances .. 94 Request Syntax .. 94 Request Parameters .. 94 Response Syntax .. 94 Response Elements .. 95 Errors .. 95 See 95 ListTags .. 96 Request Syntax .. 96 Request Parameters .. 96 Response Syntax .. 96 Response Elements .. 97 Errors .. 97 See 97 PutConferencePreference .. 98 API Version 2017-11-09viiAlexa For Business Alexa for Business APIR equest Syntax .. 98 Request Parameters .. 98 Response Elements .. 98 Errors.

8 98 See 98 PutRoomSkillParameter .. 100 Request Syntax .. 100 Request Parameters .. 100 Response Elements .. 100 Errors .. 101 See 102 Request Syntax .. 102 Request Parameters .. 102 Response Elements .. 103 Errors .. 103 See 103 RegisterAVSD evice .. 104 Request Syntax .. 104 Request Parameters .. 104 Response Syntax .. 105 Response Elements .. 105 Errors .. 105 See 105 RejectSkill .. 107 Request Syntax .. 107 Request Parameters .. 107 Response Elements .. 107 Errors .. 107 See 107 ResolveRoom .. 109 Request Syntax .. 109 Request Parameters .. 109 Response Syntax .. 109 Response Elements .. 109 Errors .. 110 See 110 RevokeInvitation .. 111 Request Syntax .. 111 Request Parameters .. 111 Response Elements .. 111 Errors .. 111 See 112 SearchAddressBooks .. 113 Request Syntax .. 113 Request Parameters .. 113 Response Syntax .. 114 Response Elements .. 114 Errors .. 114 See 115 SearchContacts.

9 116 Request Syntax .. 116 Request Parameters .. 116 Response Syntax .. 117 Response Elements .. 117 Errors .. 117 See 118 API Version 2017-11-09viiiAlexa For Business Alexa for Business APIS earchDevices .. 119 Request Syntax .. 119 Request Parameters .. 119 Response Syntax .. 120 Response Elements .. 120 Errors .. 121 See 121 SearchProfiles .. 122 Request Syntax .. 122 Request Parameters .. 122 Response Syntax .. 123 Response Elements .. 123 Errors .. 124 See 124 SearchRooms .. 125 Request Syntax .. 125 Request Parameters .. 125 Response Syntax .. 126 Response Elements .. 126 Errors .. 127 See 127 SearchSkillGroups .. 128 Request Syntax .. 128 Request Parameters .. 128 Response Syntax .. 129 Response Elements .. 129 Errors .. 129 See 130 SearchUsers .. 131 Request Syntax .. 131 Request Parameters .. 131 Response Syntax .. 132 Response Elements .. 132 Errors .. 133 See 133 SendInvitation.

10 134 Request Syntax .. 134 Request Parameters .. 134 Response Elements .. 134 Errors .. 134 See 134 StartDeviceSync .. 136 Request Syntax .. 136 Request Parameters .. 136 Response Elements .. 136 Errors .. 137 See 137 StartSmartHomeApplianceDiscovery .. 138 Request Syntax .. 138 Request Parameters .. 138 Response Elements .. 138 Errors .. 138 See 138 TagResource .. 140 Request Syntax .. 140 Request Parameters .. 140 Response Elements .. 140 API Version 2017-11-09ixAlexa For Business Alexa for Business APIE rrors .. 140 See 141 UntagResource .. 142 Request Syntax .. 142 Request Parameters .. 142 Response Elements .. 142 Errors .. 142 See 143 UpdateAddressBook .. 144 Request Syntax .. 144 Request Parameters .. 144 Response Elements .. 144 Errors .. 145 See 145 UpdateConferenceProvider .. 146 Request Syntax .. 146 Request Parameters .. 146 Response Elements .. 147 Errors .. 147 See 147 UpdateContact.