MadelineProtoDocs/old_docs/API_docs_v100/methods/messages.setBotShippingResults.md

54 lines
2.1 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.setBotShippingResults
2019-12-27 17:48:04 +01:00
description: If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.setBotShippingResults
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|query\_id|[long](../types/long.md) | Unique identifier for the query to be answered | Yes|
|error|[string](../types/string.md) | Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. | Optional|
2018-08-29 11:18:25 +02:00
|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Bool = $MadelineProto->messages->setBotShippingResults(['query_id' => long, 'error' => 'string', 'shipping_options' => [ShippingOption, ShippingOption], ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, })
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|QUERY_ID_INVALID|The query ID is invalid|
2018-04-01 13:19:25 +02:00