Difference between revisions of "HTTP API/Bot Commands/offer friendship"

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 8: Line 8:
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
 
{{API Variable|avatar|yes}} the UUID of the resident
 
{{API Variable|avatar|yes}} the UUID of the resident
{{API Variable|message|no}} optional message to send
+
{{API Variable|message|optional}} optional message to send
 +
{{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}}

Latest revision as of 15:14, 25 June 2019

Offers friendship to a resident.

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 = offer_friendship
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 UUID of the resident
message optional optional message to send
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.



<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)