Skip to main content

Referral Parent's data

All functions for working with Referral Parent data are gathered here.

❖ Referral Parent's Data

The function "Referral Parent's Data" - allows you as a creator of the bot, by using macros in the message, to show to the referral the data from the variables of his Referral Parent.

Functionality of "🧩Extensions" section: for "Referral Parent's Data " to appear, it must be activated in your bot.

Referral Parent's Data.
To connect, go in your bot:
☞ 🔐Admin | 🧩Extensions | 📂Referrals

The function was created for those who asked: "How to show to a user the details of his Ref. Parent for communication?"". For ethical reasons, we cannot simply allow you to publish the personal details of a referral parent without his permission. You yourself would not want some tens and hundreds of random people to write you any personal messages, just because some bot's admin may thought that it is a great idea to post a link to your personal account in a public space. In order to still allow referrals to somehow contact their referral parents, we created this function. However, we created it so that each referral parent can decide for himself whether to allow someone to contact him and if allowed, than in what way - through a bot, a group or directly through a private message... Moreover, to allow it, he will need to perform several thoughtful actions, personally indicating the methods of communication. This approach seems to us the most ETHICAL and HONEST in regard to the people who will use your bot.


How it works

Step 1:

You create a variable in the Bot that will contain the data that the referral parent HIMSELF will indicate as a way to contact him.

How to create a Variable

Step 2:

Next, you create a form with the "Variable Input" function and ask the user of your bot to provide data that would allow his referrals to contact him. This can be a link to a separate group in which he can gather his referrals together, or a feedback bot created by him for this purpose (if he needs a more private communication option) and, if this is his choice, he will be able to specify his own personal Telegram account details for private contact.

How to create a Variable Input Form

Step 3:

In order to show to the referral the data specified for him by his referral parent, you can use a special prefix:

Prefix: refparent_
Syntax: %refparent_varname% - the macros substitutes the value from any variable of the Referral Parent. If no Ref. Parent or no data - leaves empty space.
Where:
varname is the name of the variable you have created.

For example: a variable mylinks (the referral parent added his data for with the way to contact him), then the macros for showing to the referral will look like this: %refparent_mylinks%.

The value of other macros (except for the variable names) is not substituted - for the reasons described above.

ATTENTION: the macro consumes 1 "Token of Functions" for each data substitution in the message every time it shown.

❖ Error messages

--- - instead of the data of the referral parent.

This error will be shown if there are no "Tokens of Functions" required to show referral parent's data.

As we have mentioned above, the function of showing a referral parent's data consumes Tokens of Functions. In the message that is shown to the user, we cannot specify the cause of the error, so we simply indicate its occurrence.

❖ Referral parent macros

Referral parent Name

Macro %refparent_firstname% - will show the user's Referral Parent First name.

ATTENTION: the macro consumes 1 "Token of Functions" for each data substitution in the message every time it shown.

IMPORTANT: to use this Macros, the above function «Referral Parent's Data» - NOT NEEDED.

Referral parent Usercode

For each level of the Referral Parent there is a Macros with its Usercode. When used, the macros will show the Usercode of the Referral Parent of the corresponding level.

The macro for level 1 looks like this: %refparent_usercode1%.
Where:
refparent_usercode - prefix
1 - level number

ATTENTION: each macros consumes 5 "Tokens of Functions" MULTIPLIED by the current level - for each data substitution in the message, each time it is shown or used in an Expression, Function or Action. If there is no Referral Parent at some level - Tokens are no longer consumed.

IMPORTANT: to use this Macros, the above function «Referral Parent's Data» - NOT NEEDED.

Level 1: %refparent_usercode1% - 5 Tokens of Functions
Level 2: %refparent_usercode2% - 10 Tokens of Functions
Level 3: %refparent_usercode3% - 15 Tokens of Functions
and so on...

This functionality is extremely demanding on server resources, because the search for the Referral Parent data for each level is carried out using a full scan of the whole Database - the number of full scans corresponds to the number of macros levels.
For level one you can use macros %refparent_usercode% - it is does NOT consume Tokens.

The number of levels of Referral Parents whose macros you can use directly corresponds to the number of levels of the referral system active in your bot. Macros of non-existing levels will be ignored, if there is no Referral Parent at any of the levels, then the macros will show an empty string.


❖ Additional Information

How to use macros of Referral Parent?

For example in Actions.
● Action of Transactions (for accruals it is better to use Action of Referrals)
● Action of Message - send a message to an individual Referral Parent

 
How to create a multi-level referral system?

Read the referral system guide.