version: 2.1.3
answerShippingQuery
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
Parameters
| shipping_query_id | string | Unique identifier for the query to be answered | Optional |
| ok | bool | Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) | Yes |
| shipping_options | Array of ShippingOption | Required if ok is True. A JSON-serialized array of available shipping options. | Optional |
| error_message | string | Required if ok is False. 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 |
| token | String | You can use this method on another bot with specify this parameter | Optional |
| return_array | Boolean | Specify the result type , if pass true results will be array otherwise will be object | Optional |
| forgot | Boolean | You can set to not receive request result, dont set it or pass null for turn it off | Optional |
| answer | Boolean | You can set to answer to webhook, dont set it or pass null for turn it off | Optional |
Method errors
| ErrorName | description |
|---|---|
| required parameters not found | required parameter for this method is not founded. you can see them in log |
| answer mode not allowed | you can use answer mode only once for each webhook update and you already did |
| answer mode not allowed bc multi | you can't use answer mode when multi is on |
Method examples
$this->answerShippingQuery(['shipping_query_id' => string, 'ok' => bool, 'shipping_options' => Array of ShippingOption, 'error_message' => string]);
$this->answerShippingQuery(['ok' => bool]);
Method alices
answershippingquery
answershipping