diff --git a/docs/source/resources/BotsInteraction.rst b/docs/source/resources/BotsInteraction.rst new file mode 100644 index 00000000..b3306fe1 --- /dev/null +++ b/docs/source/resources/BotsInteraction.rst @@ -0,0 +1,39 @@ +Bots Interaction +================ + +Users can interact with other bots via plain text messages as well as inline queries. + +Inline Bots +----------- + +- If a bot accepts inline queries, you can call it by using + :obj:`get_inline_bot_results ` to get the list of its inline results: + + .. code-block:: python + + # Get bot results for "Fuzz Universe" from the inline bot @vid + bot_results = client.get_inline_bot_results("vid", "Fuzz Universe") + + .. figure:: ../_static/get_inline_bot_results.png + :width: 90% + :align: center + :figwidth: 60% + + ``get_inline_bot_results`` is the equivalent action of writing ``@vid Fuzz Universe`` and getting the + results list. + +- After you retrieved the bot results, you can use + :obj:`send_inline_bot_result ` to send a chosen result to any chat: + + .. code-block:: python + + # Send the first result (bot_results.results[0]) to your own chat (Saved Messages) + client.send_inline_bot_result("me", bot_results.query_id, bot_results.results[0].id) + + .. figure:: ../_static/send_inline_bot_result.png + :width: 90% + :align: center + :figwidth: 60% + + ``send_inline_bot_result`` is the equivalent action of choosing a result from the list and sending it + to a chat.