Guide tools
On this page
Most tools take business_id: the business the call is for. talemo_list_businesses names the businesses this connection works in. A tool that changes something also takes dry_run; with it nothing changes, and the answer shows what the change would be, or the refusal it would get.
talemo_find_guide_topics
Find topics of the Talemo guide
Find topics of the Talemo guide: how Talemo itself works — what a visit is, how the window of a channel behaves, what a refusal means, which tools to call and in what order. Pass query to get up to ten best topics, each with a line about it: the words of a question in English or Russian, or the name of a tool like talemo_book_visit to get the topics that name it. Pass module without query to list the topics of one folder, or nothing to get the contents: every folder with its topics. Read a topic with talemo_get_guide_topic. This is the guide of the product, not the knowledge of the business: its prices, rules and ways of answering are found with talemo_find_knowledge. Needs no business_id.
Guide: platform/working-with-talemo-tools.
- Reads only, changes nothing
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
lang | string | optional | Language of the answer: en (default) or ru. |
module | string | optional | A folder of the guide: booking, clients, conversations, admin-online, platform, use-cases and the like. With query it searches only there; without query it lists the topics of that folder. Leave both out for the contents. |
query | string | optional | What to look for: the words of a question, in English or in Russian, like window closed or client wrote STOP, or the name of a tool, like talemo_book_visit, to get the topics that name it. Leave it out to list. |
Described in: Working with the tools of Talemo
talemo_get_guide_topic
See a topic of the Talemo guide
Read one topic of the Talemo guide whole: its text, the tools it is about and the topics next to it. Pass the topic as the id that talemo_find_guide_topics gives, like booking/visits. The text is in English; pass lang ru for Russian. The guide tells how Talemo works; the rules and prices of the business itself are in the knowledge, talemo_get_knowledge. A topic of the use-cases folder may carry articles: the addresses of talemo.app pages where the case is told to the owner, which can be given to the person. Needs no business_id.
Guide: platform/working-with-talemo-tools.
- Reads only, changes nothing
Parameters
| Parameter | Type | Required | Meaning |
|---|---|---|---|
lang | string | optional | Language of the answer: en (default) or ru. A topic with no translation comes in English, and lang in the answer says so. |
topic | string | required | The topic as folder/slug — the id that talemo_find_guide_topics gives, like booking/visits. |
Described in: Working with the tools of Talemo