Difference between revisions of "HTTP API/Bot Commands/inventory give"
From SmartBots Developers Docs
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: | + | {{DISPLAYTITLE: inventory_give}} |
<onlyinclude>Commands bot to send an inventory item or folder to specific avatar.</onlyinclude> | <onlyinclude>Commands bot to send an inventory item or folder to specific avatar.</onlyinclude> | ||
| + | |||
| + | ''Note: this command also works in a legacy form, "give_inventory"'' | ||
{{API Variables Table}} | {{API Variables Table}} | ||
| Line 8: | Line 10: | ||
{{API Variable Group|Input}} | {{API Variable Group|Input}} | ||
{{API Variable|avatar|yes}} The avatar UUID. | {{API Variable|avatar|yes}} The avatar UUID. | ||
| − | {{API Variable|object|yes}} The inventory or folder UUID of the item. Use the [ | + | {{API Variable|object|yes}} The inventory or folder UUID of the item. Use the [https://www.mysmartbots.com/docs/Personal_Bot_Control_Panel Personal Bot Control Panel] or [[HTTP_API/Bot_Commands/listinventory|listinventory]] API command to get this UUID. |
| + | {{API Variable|nosafehub|optional}}Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters. | ||
| + | |||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
{{API HTTP Standard Output}} | {{API HTTP Standard Output}} | ||
| Line 29: | Line 33: | ||
{{HTTP API Bot - standard footer}} | {{HTTP API Bot - standard footer}} | ||
| + | |||
| + | {{NavMenu}} | ||
| + | |||
| + | __NOTOC__ | ||
Latest revision as of 15:16, 25 June 2019
Commands bot to send an inventory item or folder to specific avatar.
Note: this command also works in a legacy form, "give_inventory"
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| Input basic parameters: | ||||
| action | yes | = give_inventory | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Input: | ||||
| avatar | yes | The avatar UUID. | ||
| object | yes | The inventory or folder UUID of the item. Use the Personal Bot Control Panel or listinventory API command to get this UUID. | ||
| nosafehub | optional | Set to 1 to ignore command if bot is currently in Linden's Safe Hub (Welcome Area). Recommended for greeters and inviters. | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
Error messages
Bot checks the permissions of the item before doing the delivery. The following error message is being returned if object is no-trans:
transfer permission not set
This does not apply for folders. Empty folder is being delivered if no transferable items found.
Comments
- The inventory is loading each time your bot restarts. Allow about 60 seconds for inventory to completely load.
- Bot automatically recognizes the inventory folders and delivers them accordingly.
- The commands freezes for about 15 seconds if object UUID is not exists in bot's inventory. To avoid this make sure you are using correct UUIDs.
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
