# teleport

Teleports bot to specific location.

## Variables

The following table shows input values (you send them with the API call) and returned output values.

### Input basic parameters

| Variable | Required | Description |
|----------|----------|-------------|
| action   | yes      | = teleport  |
| apikey   | yes      | Your personal [developer's API key](/doc/developers-api-key-tw8bQj4LSJ). |
| botname  | yes      | Your bot's SL login. |
| secret   | yes      | [Bot access code](https://www.mysmartbots.com/docs/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

| Variable | Required | Description |
|----------|----------|-------------|
| location | yes      | address of the new location<br><br>Format: Region name/X/Y/Z<br><br>Use HOME instead of location to send the bot home (see examples below). |
| skip_saving_location | optional | Set to 1 or true to AVOID saving location as permanent. See comments below. |

### Output

(to be received in `http_response` LSL event, see [docs](/doc/doing-http-api-calls-c6FSEMF7bP) for details)

| Variable | Description |
|----------|-------------|
| result   | OK - command completed successfully<br>FAIL - command failed |
| resulttext | Detailed reason for the failure. |
| custom   | The value from input "custom" parameter. See above. |

## Comments

### skip_saving_location

By default bot saves the "location" you specify as base location (same as "Bot base location" in Bot Control Panel). This is a historical behavior, and it makes your bot stay in this location (on sim restart, for example).

You may not want bot to stick to the specified location. Set `skip_saving_location` to `1` or `true` and bot won't set the destination as permanent. It will stay there until teleported further, or sim restarted.

## Examples

Teleport bot to SmartBots office:

```
action=teleport&location=DuoLife/128/128/20
```

Teleport bot to its home location:

```
action=teleport&location=HOME
```