POST api/v1/bots/alexabots
Create an Alexa Bot.
Request Information
URI Parameters
None.
Body Parameters
RegisterAlexaBotRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| JustMyAccount |
Limit functionality of Alexa skill to just your Tinamous account. |
boolean |
None. |
Request Formats
application/json, text/json, application/senml+json
Sample:
{
"Name": "sample string 1",
"JustMyAccount": true
}
application/xml, text/xml
Sample:
<RegisterAlexaBotRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.AlexaBot"> <JustMyAccount>true</JustMyAccount> <Name>sample string 1</Name> </RegisterAlexaBotRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AlexaBotDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId | string |
None. |
|
| ClientSecret | string |
None. |
|
| DateAdded | date |
None. |
|
| Id |
User Id |
globally unique identifier |
None. |
| Name |
The users name |
string |
None. |
| UserName |
UserName (used to login with) |
string |
None. |
| FullUserName |
User Id and Account name |
string |
None. |
| BotType |
The type of bot. |
string |
None. |
| DisplayName |
Users first and last name |
string |
None. |
| DevicesCheckIntervalMinutes |
How often the spark account should be checked for new devices. |
integer |
None. |
| MeasurementCollectionIntervalMinutes |
How often measurements should be collected from the devices (applies to new devices only). |
integer |
None. |
| Links |
Collection of links appropriate for the user |
Collection of LinkDto |
None. |
| Actions | Collection of LinkDto |
None. |
|
| Description | string |
None. |
|
| Enabled | boolean |
None. |
|
| Authenticated |
If the bot is authenticated. |
boolean |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{
"ClientId": "sample string 1",
"ClientSecret": "sample string 2",
"DateAdded": "2025-10-24T15:02:24.822621+00:00",
"Id": "0ebc1817-128f-473e-9438-336ec053870a",
"Name": "sample string 5",
"UserName": "sample string 6",
"FullUserName": "sample string 7",
"BotType": "sample string 8",
"DisplayName": "sample string 9",
"DevicesCheckIntervalMinutes": 10,
"MeasurementCollectionIntervalMinutes": 11,
"Links": [
{
"Href": "sample string 1",
"Rel": "sample string 2",
"Action": "sample string 3"
},
{
"Href": "sample string 1",
"Rel": "sample string 2",
"Action": "sample string 3"
}
],
"Actions": [
{
"Href": "sample string 1",
"Rel": "sample string 2",
"Action": "sample string 3"
},
{
"Href": "sample string 1",
"Rel": "sample string 2",
"Action": "sample string 3"
}
],
"Description": "sample string 12",
"Enabled": true,
"Authenticated": true
}
application/xml, text/xml
Sample:
<AlexaBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.AlexaBot">
<Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
<d2p1:LinkViewModel>
<d2p1:Action>sample string 3</d2p1:Action>
<d2p1:Href>sample string 1</d2p1:Href>
<d2p1:Rel>sample string 2</d2p1:Rel>
</d2p1:LinkViewModel>
<d2p1:LinkViewModel>
<d2p1:Action>sample string 3</d2p1:Action>
<d2p1:Href>sample string 1</d2p1:Href>
<d2p1:Rel>sample string 2</d2p1:Rel>
</d2p1:LinkViewModel>
</Actions>
<Authenticated xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Authenticated>
<BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 8</BotType>
<Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 12</Description>
<DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">10</DevicesCheckIntervalMinutes>
<DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 9</DisplayName>
<Enabled xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Enabled>
<FullUserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 7</FullUserName>
<Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">0ebc1817-128f-473e-9438-336ec053870a</Id>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
<d2p1:LinkViewModel>
<d2p1:Action>sample string 3</d2p1:Action>
<d2p1:Href>sample string 1</d2p1:Href>
<d2p1:Rel>sample string 2</d2p1:Rel>
</d2p1:LinkViewModel>
<d2p1:LinkViewModel>
<d2p1:Action>sample string 3</d2p1:Action>
<d2p1:Href>sample string 1</d2p1:Href>
<d2p1:Rel>sample string 2</d2p1:Rel>
</d2p1:LinkViewModel>
</Links>
<MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">11</MeasurementCollectionIntervalMinutes>
<Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 5</Name>
<UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 6</UserName>
<ClientId>sample string 1</ClientId>
<ClientSecret>sample string 2</ClientSecret>
<DateAdded>2025-10-24T15:02:24.822621+00:00</DateAdded>
</AlexaBotDto>