Help Guide
===========
Setup Account
^^^^^^^^^^^^^^^^^^
Generate API Key
````````````````````
* Goto `API Key `__
* Now Use newly generated username and api_key in rest api
.. image:: images/apikey.png
:width: 100%
:alt: Generate API Key
Setup WebPush Notifications
`````````````````````````````
**Prerequisite**
`Setup FCM `__
* Goto Settings → `Web Push `__ → Select from Available Service Provider
.. image:: images/push_service_provider_select.png
:width: 100%
:alt: Select Service Provider
* Fill All Details
.. image:: images/fcm_push_form.png
:width: 100%
:alt: FCM Form
* Click on Submit Button
**Integration**
* Goto Settings → `Web Push `__ → Select from Your Service Provider
.. image:: images/fcm_your_providers_list.png
:width: 100%
:alt: FCM Your Providers List
* Follow integration steps to integrate your website
.. image:: images/fcm_integration_guide.png
:width: 100%
:alt: FCM Integration Guide
Setup SMS/ WhatsApp/ Voice Call Notifications
`````````````````````````````````````````````````
* Goto Settings → `SMS/ WhatsApp/ Voice Call `__ → Select from Available Service Provider
.. image:: images/sms_service_provider_list.png
:width: 100%
:alt: SMS Service Providers List
* Fill All Details
.. image:: images/twilio_sms_form.png
:width: 100%
:alt: SMS Form
* Click on Submit Button
**Add Sender**
* Goto Settings → `SMS/ WhatsApp/ Voice Call `__ → Select from Your Service Provider
.. image:: images/sms_your_service_providers.png
:width: 100%
:alt: SMS Your Service Providers List
* Click on Add Sender
.. image:: images/add_sender_list.png
:width: 100%
:alt: SMS Form
* Fill details
.. image:: images/sms_sender_form.png
:width: 100%
:alt: SMS Form
* Click on Submit Button
Setup Email Notifications
```````````````````````````````
* Goto Settings → `Email `__ → Select from Available Service Provider
.. image:: images/email_service_providers_list.png
:width: 100%
:alt: Email Service Providers List
* Fill All Details
.. image:: images/email_add_form.png
:width: 100%
:alt: Email Add Form
* Click on Submit Button
**Add Sender**
* Goto Settings → `Email `__ → Your Selected Service Provider
.. image:: images/email_your_service_providers_list.png
:width: 100%
:alt: Email Your Service Providers List
* Click on Add Sender
.. image:: images/email_senders_list.png
:width: 100%
:alt: Email Senders List
* Fill details
.. image:: images/email_sender_form.png
:width: 100%
:alt: Email Sender Form
* Click on Submit Button
Setup RSS To Campaign
```````````````````````````````
* Goto Settings → `RSS `__
.. image:: images/rss_campaign_list.png
:width: 100%
:alt: RSS Campaign List
* Click on `Push `__ OR `Email `__
.. image:: images/rss_campaign_add.png
:width: 100%
:alt: RSS Campaign Form
* Fill the form and click submit button
Setup OnSite Messaging
```````````````````````````````
* Goto Settings → `OnSite Messaging `__
.. image:: images/onsite_integration_guide.png
:width: 100%
:alt: Onsite Messaging
* Follow Integration Instructions
Setup IMAP
```````````````````````````````
* Goto Settings → `IMAP `__
* Click on Register a new IMAP
.. image:: images/imap_list.png
:width: 100%
:alt: Imap List
* Fill details
.. image:: images/imap_form.png
:width: 100%
:alt: Imap List
* Click on Submit Button
Test SetUP
````````````````
* Goto Settings → `Test Setup `__
* Click on Add SMS/Email
.. image:: images/test_setup_list.png
:width: 100%
:alt: Test Setup List
* Fill details
.. image:: images/test_email_form.png
:width: 100%
:alt: Test Email Form
.. image:: images/test_sms_form.png
:width: 100%
:alt: Test SMS Form
* Click on Submit Button
Contacts
^^^^^^^^^^^^^^
Import Contacts
```````````````````
* Goto Marketing → `Contact List `__ → Add new → `List `__
.. image:: images/contact_list.png
:width: 100%
:alt: Contact List
* Click on `Download Sample File `__
.. image:: images/contact_list_form.png
:width: 100%
:alt: Contact List Form
* Fill your data in the Downloaded file
* Fill the contact list form and click on submit button
Templates
^^^^^^^^^^^^^^^
Create Template
````````````````````
* Goto Marketing → Templates → Select Add → template
.. image:: images/template_list.png
:width: 100%
:alt: Template List
* Fill details
* Click on Submit Button
**Essential Tags**
* Unsubscribe : {{ unsubscribe|safe }}
**Personalization Tags**
* Mobile Number : {{ mobile }}
* Customer Name : {{ username }}
* Customer Email : {{ email }}
Campaign
^^^^^^^^^^^^^^^
Prerequisite
``````````````````
`Setup Your Account `__
`Import Contacts `__
`Create Template `__
Create Single Campaign
````````````````````````````````````
* Goto Marketing → `Campaign `__
.. image:: images/single_campaign.png
:width: 100%
:alt: Single Campaign List
* Select Create → `Single Campaign `__
* Fill the Campaign Form
.. image:: images/single_campaign_form1.png
:width: 100%
:alt: Single Campaign Form1
.. image:: images/single_campaign_form2.png
:width: 100%
:alt: Single Campaign Form2
* Click On Submit Button
Create Followup Campaign
```````````````````````````````````
* Goto Marketing → `Campaign `__
.. image:: images/followup_campaign.png
:width: 100%
:alt: Followup Campaign List
* Select Create → `Follow-UP Campaign `__
* Fill the Campaign Form
.. image:: images/followup_campaign_form1.png
:width: 100%
:alt: Followup Campaign Form1
.. image:: images/followup_campaign_form2.png
:width: 100%
:alt: Followup Campaign Form2
* Click On Submit Button
Create AutoResponder Campaign
```````````````````````````````````
* Goto Marketing → `Campaign `__
.. image:: images/autoresponder_campaign.png
:width: 100%
:alt: Autoresponder Campaign List
* Select Create → `AutoResponder Campaign `__
* Fill the Campaign Form
.. image:: images/autoresponder_campaign_form1.png
:width: 100%
:alt: Autoresponder Campaign Form1
.. image:: images/autoresponder_campaign_form2.png
:width: 100%
:alt: Autoresponder Campaign Form2
* Click On Submit Button
Create Onsite Messaging
```````````````````````````````````
* Goto Marketing → `Onsite Messaging `__
.. image:: images/onsite_messaging_list.png
:width: 100%
:alt: Onsite Messaging List
* Click on `Create `__ Button
* Fill All Details
.. image:: images/onsite_messaging_form1.png
:width: 100%
:alt: Onsite Messaging List
.. image:: images/onsite_messaging_form2.png
:width: 100%
:alt: Onsite Messaging List
* Click On Submit Button
Send For Review
``````````````````````````
* Goto Marketing → Campaign → Select Action → View
.. image:: images/send_for_review_action.png
:width: 100%
:alt: Send For Review View Action
* Click on Send For Review Button on Detail Page
.. image:: images/send_for_review_button.png
:width: 100%
:alt: Send For Review Button
::
After Campaign Review, Your campaign will be send at scheduled time.