ZOHO SMS plugin. Integration Document

Transcription

1 ZOHO SMS plugin Integration Document

2 Contents 1. Integration Purpose Integration Process Steps to configure a Webhook Steps to configure a workflow rule Steps to associate the webhook with the workflow Solutions Infini Technologies (I) Pvt. Ltd Page 1 of 13

3 Plugin Name ZOHO SMS plugin Version Latest 1. Integration 1.1 Purpose SI s SMS integration with ZOHO enables you to notify your customers and agents via Text Messages (SMS). Say, when a ticket is raised by your customer or a new task has been added, he would be acknowledged by an SMS notification. More so, agent will also be notified when a ticket has been assigned to him/her. 1.2 Integration Process Contact the support team for an account in promotional, transactional or international route. Then configure a webhook to send an instant notification. Create a webrule; i.e. event when the SMS has to be triggered Associate the weebhook with the webrule Steps to configure a Webhook Webhooks let you communicate with third party applications by sending instant SMS notifications every time an event occurs. With Zoho CRM webhooks, you can Solutions Infini Technologies (I) Pvt. Ltd Page 2 of 13

4 configure HTTP URLs and associate these webhooks in workflow rules to automate the notification process. Click Setup in your ZOHO CRM page. Select automation- >webhook Click Configure Webhook Enter the following details: 1. Name: Name of the webhook 2. URL to notify: 3. Method: GET/POST 4. Modules: Select one of the modules from the dropdown from where the contacts should receive SMS alerts. 5. Append entity parameters- > Parameters in the user defined format: Parameter name: xml Value description: <api> <campaign>campaign</campaign> <dlrurl></dlrurl> <time></time> <unicode>0</unicode> <flash>0</flash> <sender>bulksms</sender> <message>hi ${Contacts.First Name},Welcome To Zoho Crm.</message> <sms> <to>${contacts.mobile}</to> </sms> </api> Parameter name: json Value description: OR Solutions Infini Technologies (I) Pvt. Ltd Page 3 of 13

5 { "sender": "AAAAAA", "campaign": "TEST", "dlrurl": "", "message": "message text ${Contacts.First Name}", "unicode": 0, "flash": 0, "sms":[{ "to": ${Contacts.Mobile} }] } Solutions Infini Technologies (I) Pvt. Ltd Page 4 of 13

6 Parameter Name Campaign dlrurl time unicode flash Sender message to description Your SMS campaign name The URL to receive delivery reports. Spiffing reference id is mandatory. EX: Schedule time. EX Format: YYYY- MM- DD HH:MM:SS OR YYYY- MM- DD HH:MM AM/PM To specify if the message to be sent is in Unicode format or not. EX values: 1/0/auto(automatically detects if Unicode is present) To specify if the message has to be sent as a flash message or not. EX values: 1/0 Sender ID assigned to your account Message that has to be sent. To add custom parameters, select module- >field- >insert. In the above example customer first name from contact module is used Number to which the SMS has to be sent. Select module- >field(that contains mobile number)- >insert type optional optional optional optional optional Mandatory Mandatory mandatory 6. Append Custom Parameters: Parameter name- >parameter value Api_key- > api_key assigned to your account Method- > If parameter name is xml, method is sms.xml If parameter name is json, method is sms.json Sender- >sender ID assigned to your account 7. Preview URL: Click on refresh now to view and verify the API URL generated Save the configuration. Solutions Infini Technologies (I) Pvt. Ltd Page 5 of 13

7 Figure 1: Webhook configuration1 Solutions Infini Technologies (I) Pvt. Ltd Page 6 of 13

8 Figure 2: Webhook Configuration2 Solutions Infini Technologies (I) Pvt. Ltd Page 7 of 13

9 Figure 3: Webhook Configuration Steps to configure a workflow rule Workflow rules automate your business processes. They are a set of rules that are executed when certain specified conditions are met. These rules can include alerts, tasks, field updates, webhooks and followups that can be set as an instant action or time based actions Click on setup in your ZOHO CRM page. Select automation- >workflow Click on create rule. Enter the following details: Basic Information 1. Module: Select a module from the dropdown on which the rule has to be applied 2. Rule name: specify the rule name Solutions Infini Technologies (I) Pvt. Ltd Page 8 of 13

10 3. Status: active/inactive 4. Description: Description to the rule Figure 4: Workflow Rule- Basic Information Solutions Infini Technologies (I) Pvt. Ltd Page 9 of 13

11 Rule trigger Choose an action based on which rule has to be executed Figure 5: Workflow Rule- Rule Trigger Solutions Infini Technologies (I) Pvt. Ltd Page 10 of 13

12 Rule criteria The rule will be executed for the newly created or updated Contacts that match the following rule criteria Figure 6: Workflow Rule- Rule Criteria Steps to associate the webhook with the workflow Action: Click on call webhook. Select the folder icon to choose from the existing webhooks or create a new webhook as per the process explained above. Select Associate and Save. Solutions Infini Technologies (I) Pvt. Ltd Page 11 of 13

13 Note: API document will be shared with you during integration, to check for various error codes. Solutions Infini Technologies (I) Pvt. Ltd Page 12 of 13