Difference between revisions of "Template:HTTP API command"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE: command_name}} <onlyinclude>...</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|command_name}} {{API Variable Group|Input}} {{API Variable|pa...") |
|||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: command_name}} | {{DISPLAYTITLE: command_name}} | ||
| − | < | + | <tag_onlyinclude>...</tag_onlyinclude> |
{{API Variables Table}} | {{API Variables Table}} | ||
Latest revision as of 21:31, 2 May 2017
<tag_onlyinclude>...</tag_onlyinclude>
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 | = command_name | ||
| 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: | ||||
| param_name | yes | param description | ||
| 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. | |||
Examples
Examples go here:
action=move&instruction=FORWARD¶m1=START
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
