MadelineProto/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md

85 lines
1.9 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
title: messages.setBotShippingResults
description: messages.setBotShippingResults parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
## Method: messages.setBotShippingResults
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-06-30 15:36:33 +02:00
|query\_id|[long](../types/long.md) | Yes|
|error|[string](../types/string.md) | Optional|
|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|
2017-06-30 15:36:33 +02:00
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|QUERY_ID_INVALID|The query ID is invalid|
2017-09-01 12:27:38 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->messages->setBotShippingResults(['query_id' => long, 'error' => 'string', 'shipping_options' => [ShippingOption], ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.setBotShippingResults
2017-07-23 16:40:54 +02:00
* params - `{"query_id": long, "error": "string", "shipping_options": [ShippingOption], }`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setBotShippingResults`
Parameters:
query_id - Json encoded long
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
error - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
shipping_options - Json encoded array of ShippingOption
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, })
```