Difference between revisions of "HTTP API/Bot Commands/set http callback"

From SmartBots Developers Docs
Jump to: navigation, search
Line 1: Line 1:
{{DISPLAYTITLE: set_http_callback (HTTP Bot Command)}}
+
{{DISPLAYTITLE: set_http_callback}}
 
<onlyinclude>Specifies your HTTP callback script to receive bot events (invitations, IMs etc).</onlyinclude>
 
<onlyinclude>Specifies your HTTP callback script to receive bot events (invitations, IMs etc).</onlyinclude>
  

Revision as of 15:16, 29 June 2016

Specifies your HTTP callback script to receive bot events (invitations, IMs etc).

See HTTP Bot Callback for detailed information.

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 = set_http_callback
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:
url The URL of your HTTP script. This script will get POST requests from the bot.

Send an empty URL to disable HTTP callback.

events The events you want to receive, separated by a comma. See HTTP Bot Callback Events for complete a list of events.
  • Separate events by comma if you want to monitor several of them: events=group_invite,teleport_offer
  • Specify events=all to monitor all possible events.
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)