DOCUMENTATION
OMNICHAT RESELLER VERSION
Thank you for joining the reseller program! Please complete the steps below to start your new business with us.
POINT YOUR DOMAIN TO OUR SERVER
1. Edit the DNS settings of your domain and add:
- Record type A with an empty string or your domain as hostname, and add the provided IP we give you as value
- Record type CNAME with www as hostname and your domain without www as value
2.We will only install OmniChat on the given domain, we will not upload any landing pages or websites. For this reason, consider using a subdomain like chat.example.com
INFORMATION YOU MUST SEND US
Please send us all the information below through a ticket at our website: http://planifyx.com/contact-us.
Your domain name
The domain you want to use and points to our server. E.g. https://chat.example.com
Pusher (OPTIONAL)
Required only to send push notifications
- Pusher ID
- Pusher Key
- Pusher Secret
- Pusher Cluster
How to get the information
1. Register to Pusher at https://pusher.com/.
2. Create a new channel and click the left menu App Keys.
Smtp
1. SMTP Host
2. SMTP Username
3. SMTP Password
4. SMTP Port
5. SMTP Sender email
6. SMTP Sender name
How to get the information
1. You can use any SMTP server but make sure it works correctly and emails are not sent to SPAM folder. Some of the best providers are https://sendgrid.com/ and https://www.smtp.com/.
PAYMENT GATEWAY (CHOOSE ONLY ONE)
Stripe (RECOMENDED)
Stripe is available only in the countries listed at https://stripe.com/global. If your country is not listed use Rapyd instead, details are below.
1. Live Secret Key
2. Live Product ID (send only 1 product ID)
3. Currency code
How to get the information
1. Register a Stripe account at https://dashboard.stripe.com/register.
2. Activate your account at https://dashboard.stripe.com/account/onboarding
3. Visit https://dashboard.stripe.com/webhooks/ and add an end point, in Endpoint URL enter https://your-domain/account/stripe.php (replace your-domain with your domain of point 1). Listen for the following events: checkout.session.async_payment_failed, checkout.session.async_payment_succeeded,checkout.session.completed, checkout.session.expired, invoice.paid, invoice.payment_failed, payment_intent.succeeded.
4. Create a new product at https://dashboard.stripe.com/products/. Enter the product name and add a new price for each OmniChat subscription you want to offer to your customers. Each price must have the following settings:
- Pricing model: Standard pricing
- Tax code: Software as a service (SaaS)
- Recurring
- Billing period: all values except “custom” are supported
- Include tax in price: No
5. Save the product and open it, you must send us the ID. E.g. prod_KeiX3uOIziW5UH. Send only 1 product ID.
6. Get the secret key from https://dashboard.stripe.com/apikeys.
7. white Label option: If you want to offer the option to hide your brand from the chat widget, create a second product with 1 price and send the product ID.
How to create the memberships
3. Go to https://dashboard.stripe.com/products and select the product.
2. Add the prices within the product, ensuring each price follows the specified settings mentioned earlier.
3. Navigate to the OmniChat super admin area to view the newly added prices. Finish the membership setup and save the changes.
Razorpay
Stripe is the recommended payment provider. Use Razorpay only if you cannot use Stripe.
1. Key ID
2. Key Secret
3. Currency symbol
How to get the information
1. Register a Razorpay account at https://razorpay.com.
2. Go to Account & Settings > Webhooks and add a new Webhook. Enter
https://your-domain/account/razorpay.php (replace your-domain with your domain of point 1). Listen for the following events: “Payment Completed”. Activate the following events: payment.authorized, subscription.charged.
3. Go to API Keys & Plugins and generate a new Key ID and Key Secret pair.
How to create the memberships
1. Go to https://dashboard.razorpay.com/app/plans and new plans. Each plan is a membership. The Billing Frequency must be 1 month or 1 year.
2. Navigate to the OmniChat super admin area to view the newly added plans. Finish the membership setup and save the changes. To disable a plan, set the quota to -1.
Rapyd
Stripe is the recommended payment provider. Use Rapyd only if you cannot use Stripe. Currently, Rapyd does not support recurring payments, so your customers will need to manually renew their OmniChat Cloud subscription, it won’t be automatic.
1. Access Key
2. Secret Key
3. Currency symbol
4. Country code
How to get the information
1. Register a Rapyd account at https://www.rapyd.net/.
2. Activate and verify your account.
3. Go to https://dashboard.rapyd.net/developers and send us Secret key and Access key.
4. Go to https://dashboard.rapyd.net/developers and in Webhooks URL enter
https://your-domain/account/rapyd.php (replace your-domain with your domain of point 1). Listen for the following events: Payment Completed.
5. Go https://dashboard.rapyd.net/settings/checkout-page, click the link icon and as enter https://your-domain/account?tab=membership (replace your-domain with your domain of point 1) as Fallback URL.
6. Send the main currency symbol of your OmniChat cloud business. Get it from https://en.wikipedia.org/wiki/ISO_4217#Active_codes (send us the code field).
7. Send the main country code of your OmniChat cloud business. Get it from https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes (send us the ISO 3166-1 alpha-2 code field).
How to create the memberships
Create them from the OmniChat super admin area.
Open Exchange
OpenExchange App ID
How to get the information
You Register an account at https://openexchangerates.org/ and get the App ID from the App IDs area.
OneSignal
1. OneSignal App ID
2. OneSignal App Key
How to get the information
1. You Register an account at https://onesignal.com/ and follow the docs at https://help.planifyx.com/docs/push-notifications/ .
2. As Path to service worker files and Service worker registration scope enter /.
Twilio for SMS (optional)
Required only to send SMS notifications and to validate the customer’s phone number
1. Twilio SID
2. Twilio Token
3. Twilio Sender phone number
How to get the information
1. Register to Twilio at https://www.twilio.com/.
2. Follow the docs at https://help.planifyx.com/docs/text-message-notifications/
Your preferred membership system
You can use only one of the following systems:
1. Users count. Your customers will buy users quotas and the cost is linked to the number of registered users.
2. Messages count. Your customers will buy messages quotas and the cost is linked to the number of messages sent.
3. Messages and agents count. Your customers will buy messages quotas and agents quotas and the cost is linked to both the number of messages sent and the number of registered agents and admins.
More details
1. Only for the messages count. If a customer with an active membership upgrade to a new membership, the messages count doesn’t restart, it remains the same.
2. Only for the messages count. The membership tier is based only on the number of messages sent each month. All messages are counted: chat messages from agents and users, direct messages, messages from users and agents, messages from the Dialogflow chatbot.
3. When the monthly message count exceeds the subscription quota (only for messages count) or the agents count (only for agents count) or the users count(only for users count system), or the membership is expired and not renewed, the admin area is disabled. The chat still works and receives messages, only the admin area is disabled. No messages are lost.
4. To offer unlimited agents set the quota to 9999.
5. How will your users purchase your membership plans? Once the installation is complete, everything will be ready and the users will be able to purchase your membership plans immediately. They will only need to register an account and purchase a plan from their account area.
6. The free quota is available only in the free plan. When the customer buys a paid membership, and the membership quota is reached, the account is suspended.
7. The free plan quotas cannot exceed 100 messages a month, 1 agent, 10 users.
8. There is a minimum quota related to the plan price. If you set a quota larger than the maximum quota for the plan price, the maximum quota will be used instead. To view the maximum quota, visit https://help.planifyx.com/wp-content/uploads/2024/10/max-quota.txt.
9. You can manually renew a customer’s subscription from the super admin area: open the edit customer window, and under “Membership” select ” Manual membership renewal”.
10.You can manually assign credits to a customer from the super admin area: open the edit customer window, and under “Credits” enter the amount.
Your business and brand details
1. Your business name.
2. Your business full logo in SVG format. No transparent spaces around.
3. Your business logo icon in SVG format, icon only. It should be square size. No transparent spaces around
INFORMATION
1. The default language is English and can also be automatically detected from the user’s browser language.
2. Customers will use your SMTP server as default server for all emails.
3. Customers receive email notifications when their membership quota is 90% full and when it is 100% full or has expired, in this case, the admin area is disabled. The chat will continue to work and no messages or users will be lost.
4. The affiliate area is activated after setting the fee in Super admin > Settings > Referral fee. You have to send the affiliate payment manually and immediately after the payment reset to zero the affiliate earnings from Super admin > Affiliates. Users have up to 60 days to purchase a plan before the commission expires. Affiliates earn a commission on any first membership purchase they refer.
