Talemo Docs

Launch 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.

All topics of Launch

talemo_get_launch

See the launch of the business

Show how far the launch of a business has got: eight steps in order — payment, business, services, memos, rehearsal, channel, first_reply and own, the online admin answering by itself —, each with its state (done, now, later or skip) and the word for its action (start, check, open, running; empty when done or skipped). The steps are worked out from what the business has, not ticked off: delete the last service with a price and services opens again. now is the first step not done, not skipped and not put off; with none left, the first one put off. Also spent_usd since the business was created and invested_usd, what it was opened with, in dollars down to the cent, each beside its thousandths of a credit (spent_millicredits, invested_millicredits, a credit being one cent; tell the person the dollars), and only for a role that sees the money of the business (billing.view): for any other the fields are absent, not zero; finished when the online admin is switched on to answer by itself, and closed when the person hid the launch card. Once finished and not hidden, own_reply is the first message the online admin sent by itself — empty if none yet —, with visit: the client, the time and the service of the visit it booked in that conversation, only for a role that sees visits and client cards.

Guide: launch/launch-path.

  • Reads only, changes nothing

Parameters

ParameterTypeRequiredMeaning
business_idstringrequiredBusiness ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden.

Described in: Onboarding a new business, The launch path of a business

talemo_set_launch_choice

Choose what to do with a launch step

Record what the person chose for a step of the launch path: later puts the step off and the path goes on to the next one, skip skips it, and closed hides the launch card once the launch is complete; hidden stays hidden. Returns the whole path as it is now. Ask the person first; with dry_run nothing is recorded and the answer is the path as it would be. A step that is done is not put off or skipped: status 409, code launch.step_done. Payment and business are facts and are never put off or skipped: launch.step_fixed. closed before the online admin answers by itself: launch.not_finished. A name that is not a step: status 404, code launch.step_unknown. A role without the right to change the business is refused with status 403 and code role.forbidden.

Guide: launch/launch-path.

  • Changes data
  • The same call twice gives the same result

Parameters

ParameterTypeRequiredMeaning
business_idstringrequiredBusiness ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden.
choicestringrequiredlater — put the step off; skip — skip it; closed — hide the launch card once the launch is complete.
dry_runbooleanoptionalTrue — change nothing and answer the path as it would be.
stepstringrequiredThe step of the launch path: payment, business, services, memos, rehearsal, channel, first_reply or own. talemo_get_launch lists them.

Described in: Onboarding a new business, The launch path of a business

Make a sign-up link for a conversation

Get a sign-up link to Talemo that carries the mark of this conversation, to put into a reply: a sign-up through it is counted to this conversation. The link also carries the industry the client named in the conversation and, when Talemo speaks it, the language of the conversation: the page opens in that language with the industry already chosen. Only the Talemo business itself has sign-up links; any other business is answered not_found. The link reaches the client only inside a message to them. When: the client of the Talemo business itself asks how to sign up or to try Talemo. How: no arguments but the conversation. Next: put the link into the message as it is; not_found means this business has no sign-up links — do not make one up. With dry_run the answer is the link without its token, and nothing is recorded.

Guide: launch/signup-link-from-chat.

  • Changes data

Parameters

ParameterTypeRequiredMeaning
business_idstringrequiredBusiness ID: one of the businesses this connection may work in — talemo_list_businesses names them. Another business is refused with door.business_forbidden.
conversation_idstringrequiredConversation ID: talemo_list_conversations finds them.
dry_runbooleanoptionalTrue — change nothing and answer the conversation as it would be.

Described in: Sign-up link from a conversation